codeX docs Jekyll Skellington :skull:

A barebones skeleton for applying to codeX documentation (such as the narrative, code katas, and concept cards) to publish it as a Jekyll and GitHub Pages-powered web site.

This lets us write the docs in Markdown, and use fancy syntax highlighting.

This generator uses yeoman.io.

Install yeoman like this:

npm install -g yo

Then install the generator like this:

npm install -g generator-codex-skellington

Then, whenever you want to make a new codex module, you do

yo codex-skellington

It asks you the name, then makes all the files for you.

Things to update

Navigation

In _includes/footer.html, add links to any other pages inside the ordered list.

Layout in the YAML front-matter

There are two layouts:

• default for most things;
• single for single-page doc items that don't need a navigation block.