This repository contains the source for the Geotrellis documentation website.
Jekyll is required. Follow the install instructions at the Jekyll wiki. In most cases, you can install via RubyGems:
gem install jekyll
OSX users might need to update RubyGems:
sudo gem update --system
Grab the RubyInstaller. Try release 1.8.x if you experience unicode problems with 1.9.x.
Follow the instructions for RubyInstaller DevKit.
Install Jekyll using the gem package manager:
gem install jekyll
Checkout the gh-pages branch, and build by:
jekyll --server
The generated site is available at http://localhost:4000
If you get incompatible encoding errors when generating the site under Windows, then ensure that the
console in which you are running jekyll can work with UTF-8 characters. As described in the blog
Solving UTF problem with Jekyll on Windows
you have to execute chcp 65001. This command is best added to the jekyll.bat-script.
The markdown used in this site uses Maruku extensions.
There exists a free markdown editor for OSX called Mou. It's quite convenient to work with, and it generates the translated Markdown in real-time alongside of your editor window, as can be seen here:
