The static, markdown based, Jekyll powered Warp10's site
Jekyll is a simple, blog-aware, static site generator. It takes a template directory containing raw text files in various formats, runs it through Markdown and Liquid converters, and spits out a complete, ready-to-publish static website suitable for serving with your favorite web server. Jekyll also happens to be the engine behind GitHub Pages.
The full doc on Jekyll is available on Jekyll's doc site.
Using ruby gems:
gem install jekyll
Note: the version of Jekyll on Ubuntu repositories isn't up to date and shouldn't be used
To serve the site in preview mode, use:
jekyll serve
The preview mode automatically updates after any modification.
To build the static version of the site, use:
jekyll build
If you want it to rebuild the static site after each modification, add the --watchflag:
jekyll build --watch
In watch mode, Jekyll will scan the source file and re-generate the blog when files changes.
To write a new page, you add a markdown file to corresponding folder.
Filename must respect the naming convention:
title-with-dashes.markdown
The markdown files must include a normalized header:
---
layout: "function"
title: "A nice title"
subtitle: "And the explanation thats follows it"
---
The content of the page is written in markdown.
Images should be placed on a directory inside img, following this structure:
──img
└──page-filename-without-.md
└──img01.jpg
└── img02.jpg
As usual, you should fork the repository, push to your fork and do a pull request.