Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tyrchen/podgen
Statically generate a podcast site with itunes enabled rss. See live demo:
https://github.com/tyrchen/podgen
Last synced: 5 days ago
JSON representation
Statically generate a podcast site with itunes enabled rss. See live demo:
- Host: GitHub
- URL: https://github.com/tyrchen/podgen
- Owner: tyrchen
- License: other
- Created: 2015-07-31T16:31:58.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-04-11T20:23:57.000Z (over 4 years ago)
- Last Synced: 2024-08-01T19:32:33.980Z (3 months ago)
- Language: Go
- Homepage: http://podcast.tchen.me
- Size: 36.1 KB
- Stars: 27
- Watchers: 5
- Forks: 1
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# podgen
Podgen is a tool for statically generate a podcast site with itunes enabled rss. After putting your generated online, you could register your rss against itunes podcast so that your awesome voice could be reached everywhere.
This project is highly inspired by go projects from hashicorp. The ``./scripts`` is from **consul** and the CLI is modified based on **vault** (this is not true anymore, now the CLI is using github.com/spf13/cobra).
## Installation
For Mac OSX, the easiest way to download the current [release](https://github.com/tyrchen/podgen/releases/latest) from [tyrchen/podgen release](https://github.com/tyrchen/podgen/releases).
Later on we will support homebrew so that you could install directly with:
```
$ brew install podgen
```
For linux user, please download source code and compile it yourself.
podgen doesn't support windows at this stage. I will finish all the functionalities then consider windows support. Sorry.
## Usage
To use podgen, first of all, you need to init a site. Please create a repo in github and close it into your local directory:
```
$ git clone [email protected]:yourname/xyz.git
$ cd xyz
$ podgen init [--template github.com/tyrchen/podgen-basic]
```
[note] If you don't pass ``--template`` to the ``init`` command, it will use the ``tyrchen/podgen-basic`` template from github.
It will create configuration files for you to use:
```
$ ls
build CNAME channel.yml items.yml assets template
```
And it will create a ``gh-pages`` branch to store the build target. Just same as any other github powered static site.
Then edit ``channel.yml`` to put your channel information and add your podcast items into ``items.yml``. Finally copy your mp3 into ``assets`` folder. You're almost set! Ah, if you want to use it against your customer domain, set the ``CNAME`` file!
The last step is to build the project:
```
$ podgen build
```
Build should be done very quickly. It will generate the podcast site and rss, put them into ``build``, then push all the changes under ``build`` to ``gh-pages``. You shall then see the generated site in less than a minute.
If everything looks fine. You just need to issue "podgen push" to push the source and generated html to ``master`` and ``gh-pages``.
```
$ podgen push -m "add a new episode"
```
Meanwhile, your itunes podcast app shall get the latest rss. Try it and have fun!
If later on you want to add new episode, just run `podgen new` and it will create new items in your `items.yml`. Just change the title/description and put your music file into `assets` directory and you're all set!
Feel free to view a live demo of my podcast site: [programmer life](http://podcast.tchen.me). It is also available in iTunes/podcast.