vicarium / prisonplanes

A set of public documents making up the lore of the "Tales from the Prison Planes" setting.

MkDocs Jekyll Theme

This is a starter template for a mkdocs jekyll theme, based on these two previous arts:

• alexcarpenter/material-jekyll-theme
• squidfunk/mkdocs-material

Usage

1. Get the code

You can clone the repository right to where you want to host the docs:

git clone https://github.com/vsoch/mkdocs-jekyll.git docs
cd docs

2. Customize

To edit configuration values, customize the _config.yml. To add pages, write them into the pages folder. You define urls based on the permalink attribute in your pages, and then add them to the navigation by adding to the content of _data/toc.myl.

3. Options

Most of the configuration values in the _config.yml are self explanatory, and for more details, see the about page rendered on the site.

4. Serve

Depending on how you installed jekyll:

jekyll serve
# or
bundle exec jekyll serve