Command Line Tool
The octopod-jekyll command line commands are:
$ octopod b[uild]
# builds from current path . to ./_site
$ octopod build <path/to/target>
# compiles and builds the site from the current path . to path/to/target
$ octopod build <path/to/source> <path/to/target>
# compiles from source_path to path/to/target
$ octopod import <importer name> <options>
# imports posts using named import script
$ octopod setup
# Sets up Jekyll site to become podcast-aware, copies assets and default config.
# Asks for confirmation on file overwrite.
$ octopod update
# Updates an existing site's template files to the currently installed
# jekyll-octopod version. Unlike `setup`, it never touches _posts/, imprint.md,
# index.md or the demo episodes/ files - those are always left alone, since this
# targets sites that are already live with real content. Also removes any
# leftover local copy of a file that's now served by the jekyll-octopod-bulma
# theme gem instead (layouts, includes, the Podlove player, the subscribe
# button, ...), keeping any '.md' file found along the way, and rewrites the
# retired {% podigee_player %} tag to {% podlove_player %} in any post that
# still uses it.
$ octopod episode
# adds a post for a new episode
$ octopod deploy
# deploys your site via rsync
$ octopod <command> --help
# for more information on a specific command.
$ octopod s[erver]
# Starts the serverConfiguration is read from ‘_config.yml.
In case you deleted some of the options, a full reference can be found in
assets/_config.yml.sample
in the jekyll-octopod gem itself.
For octopod episode, the following options are available to override defaults:
-a, --author [AUTHOR]
-c, --chapters [CHAPTER1, CHAPTER2...]
# Chapters have the format "HH:MM:SS.sss Title"
-d, --duration [DURATION]
# "HH:MM:SS.sss"
-e, --explicit [yes/no]
-l, --layout [LAYOUT]
# Defaults to 'post', should never need to be changed
-p, --posts-dir [PATH]
# Defaults to '_posts'
-s, --subtitle [TEXT]
--summary [TEXT]
--tags [TAG1, TAG2, ...]
-t, --title [TEXT]All derived Jekyll command line tasks can be found in Jekyll’s Usage Documentation, from which the octopod command inherits most of its functionality.
If there is an error when building the site, using the -t option prints
out the full stack trace, which can be helpful in debugging and improves bug reports.
Continue reading with Liquid filters.
