Very much in progress...
This site is built with jekyll , a static site generator.
- Make sure Ruby is installed
- Install jekyll:
sudo gem install jekyll
- Install kramdown :
sudo gem install kramdown
- Install Pygments :
sudo apt-get install pygments
The command jekyll serve --watch
will generate the site in the _site
directory, watch source files for changes, and serve it locally on port 4000.
- Add a markdown file with the following naming convention to the
_posts
directory: YYYY-MM-DD-[title-of-the-tutorial].md. - In
_config.yml
make sure the author of the tutorial exists in theauthors
list. - Add the following to the top of the tutorial markdown file:
---
title: (the title of the tutorial)
author: (the author key in the list in `_config.yml`)
layout: tutorial
---
{% include tutorial-header.html %}
(...your content here.)
The content between the ---
's is FrontMatter . The content between the {% %}
is Liquid .
Wrap any code snippets in the totorial in the following Liquid statements:
{% highlight LANGUAGE_IDENTIFIER %}
... code ...
{% endhighlight %}
Language identifiers can be found on the Pygments website.
You can add line numbers to the code snippet by including linenos
after the language identifier, i.e. {% highlight scala linenos %}
- Changes made to
_config.yml
will not be caught inwatch
mode--need to restart jekyll.