Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/songmu/podbard

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/songmu/podbard
Owner: Songmu
License: mit
Created: 2024-08-31T13:25:31.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-10-09T10:48:50.000Z (29 days ago)
Last Synced: 2024-10-11T21:09:23.331Z (27 days ago)
Language: Go
Homepage: http://junkyard.song.mu/podbard/
Size: 7.97 MB
Stars: 15
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        Podbard

=======

[![Test Status](https://github.com/Songmu/podbard/workflows/test/badge.svg?branch=main)][actions]

[![Coverage Status](https://codecov.io/gh/Songmu/podbard/branch/main/graph/badge.svg)][codecov]

[![MIT License](https://img.shields.io/github/license/Songmu/podbard)][license]

[![PkgGoDev](https://pkg.go.dev/badge/github.com/Songmu/podbard)][PkgGoDev]

[actions]: https://github.com/Songmu/podbard/actions?workflow=test

[codecov]: https://codecov.io/gh/Songmu/podbard

[license]: https://github.com/Songmu/podbard/blob/main/LICENSE

[PkgGoDev]: https://pkg.go.dev/github.com/Songmu/podbard

The Podbard is a primitive podcast site generator.

![](docs/ja/static/images/artwork.jpg)

[Document site (Japanese)](https://junkyard.song.mu/podbard/)

## Synopsis

```console

# Initialize the site

$ podbard init .

✨ Initialized your brand new podcast project under "." directory

# Locate the audio file and create a new episode page

$ podbard episode audio/1.mp3

🔍 The episode file "episode/1.md" corresponding to the "1.mp3" was created.

# Build the site

$ podbard build

🔨 Generating a site under the "public" directrory

🎤 Your podcast site has been generated and is ready to cast.

```

## Description

The podbard is software that generates a minimum podcast sites from a list of audio files.

## Template Repository

- 

    - GitHub Pages

- 

    - Cloudflare Pages + R2

- 

    - Cloudflare Pages + R2 (Private Podcast)

You can start a new podcast site by using the template repository without installing the `podbard`.

## Installation

How to install on terminal

```console

# Homebrew

% brew install Songmu/tap/podbard

# Install the latest version. (Install it into ./bin/ by default).

% curl -sfL https://raw.githubusercontent.com/Songmu/podbard/main/install.sh | sh -s

# Specify installation directory ($(go env GOPATH)/bin/) and version.

% curl -sfL https://raw.githubusercontent.com/Songmu/podbard/main/install.sh | sh -s -- -b $(go env GOPATH)/bin [vX.Y.Z]

# In alpine linux (as it does not come with curl by default)

% wget -O - -q https://raw.githubusercontent.com/Songmu/podbard/main/install.sh | sh -s [vX.Y.Z]

# go install

% go install github.com/Songmu/podbard/cmd/podbard@latest

```

## Directory Structure

- **index.md**

    - index page

- **podbard.yaml**

    - configuration file

- **episode/**

    - episode pages in markdown

- **audio/**

    - audio files (mp3 or m4a)

- **template/**

    - template files (tmpl files in Go's text/template syntax)

- **static/**

    - static files

## Sub Commmands

### init

```console

$ podbard init .

```

### episode

```

$ podbard episode [-slug=hoge -date=2024-09-01 -title=title] audio/1.mp3

```

create a new epoisode page with the specified audio file.

### build

```

$ podbard build

```

build the site and output to the `public` directory.

## Author

[Songmu](https://github.com/Songmu)