Skip to content
This repository was archived by the owner on Nov 9, 2020. It is now read-only.

Added documentation about theming #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added documentation about theming #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion pages/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can find a documentation of all the non-Octopod-specific settings on the [Co

Jekyll is highly customizable, if you are into coding (or even just want to get into it), read the [Jekyll Documentation](https://jekyllrb.com/docs/home/). It is very detailed and quite easy to grasp.

First of all, your new podcast episode needs audio data. Octopod assumes that your ready to use audio files stay within the `episodes` directory in your projects root.
First of all, your new podcast episode needs audio data. Octopod assumes that your ready to use audio files stay within the `_episodes` directory in your projects root.

{% highlight shell %}
$ cp ~/my_superduper_audio_files/ocp001.m4a episodes
Expand Down Expand Up @@ -69,6 +69,13 @@ This is where all the metadata is stored. Below the YAML frontmatter is the area
This strange looking {% raw %}`{{ podigee_player page }}`{% endraw %} thingy is the [Liquid filter](./liquid-filters),
which represents the iframe where the web player will be included later.

You can also change the theme from the default. To do so, you have to override the SASS variables that jekyll-bootflat uses. If you just have a few changes you want to make,
you can put these directly into ```_sass/_overrides.scss```. However, if you wish to make an entire theme and possibly share this theme with others, we recommend that you create
a subdirectory in ```_sass``` named after your theme and to only import that theme in the ```_overrides.scss``` file. A sample theme for this is included.

To find out which variables exist, look at the [jekyll-bootflat](http://bootflat.github.io/) documentation and the bootflat and bootstrap files in octopod, which you can find
[here](https://github.com/jekyll-octopod/jekyll-bootflat/tree/master/_sass).

When all this work is done you are ready to take a first look.
The following command generates your site and starts a local webserver for a preview. You can check your new podcasting website by opening [http://localhost:4000](http://localhost:4000).

Expand Down