README.md

GeoMesa.org

Very much in progress...

This site is built with jekyll , a static site generator.

Installing jekyll

Jekyll v3 is now used on github.io.

jekyll v3

1. Make sure Ruby and its development package are installed: sudo apt-get install ruby ruby-dev
2. Install jekyll: sudo gem install jekyll (requires ruby > on Ubuntu)
3. Install jekyll-redirect-from: sudo gem install jekyll-redirect-from
4. Install kramdown : sudo gem install kramdown
5. Install rouge : sudo gem install rouge
6. Install nodejs: sudo apt-get install nodejs for the javascript/coffeescript runtime

Generate and serve the site

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.

Adding a tutorial

OBSOLETE: Many tutorials are now in the Sphinx-based documentation tree in the GeoMesa; consider putting your tutorial there instead.

1. Add a markdown file with the following naming convention to the _posts directory: YYYY-MM-DD-[title-of-the-tutorial].md.
2. In _config.yml make sure the author of the tutorial exists in the authors list.
3. 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 .

Syntax highlighting

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 %}

Notes

• Changes made to _config.yml will not be caught in watch mode--need to restart jekyll.