Giter Club home page Giter Club logo

pod-build's Introduction

pod-build

pod-build is a local development environment for podcast publishing.

It uses open technologies and opinionated defaults to generate a hostable podcast feed bundle.

Input: config.json with accompanying content directory.
Output: Hostable public directory.

Generator transforms a Config object (usually imported from config.json) into a Channel object, which contains formatted and validated field text for the elements of a standard podcast feed's XML (RSS) file. The generator is designed to be extendable. The referenced media files are copied from the local content folder to public/media.

The RSS writer RSS.writeRSS() outputs the channel's state in XML format with podcast feed headers. By default, this file is written to public/rss.xml.

SiteBuilder builds a static site in public, creating each page specified in the podcast fields.

config.json

generator: { ... }

channel: { ... }

domain: Host domain for links.

title: Title of feed

pubDate: Publication date of this version of the feed (any string recognized by Date)

copyright: Copyright/License declaration

rss.xml

<channel>

<title>

Title of feed (plain text)

<pubDate>

Publication date of this version of the feed (RFC2822 string)

<link>

URL of the host domain (URL string)

<copyright>

Copyright/License declaration (plain text)

<generator>

Name and version of this generator

<docs>

Link to a documentation page. docs.html hosted at HOST/docs

<description>

TODO

  • Expand documentation on dev side (this doc) and user-facing (/docs.html)
  • Allow more flexibility for configuration - right now, the defaults are the only way to do some things

pod-build's People

Contributors

jimmyaffatigato avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.