The RoboFont documentation is built with Jekyll, a site generator which converts Markdown sources and some other files in into a static website.

Jekyll comes with a built-in development server which allows you to preview how the generated site will look like in your browser, locally.

Installing Jekyll

If you haven’t used Jekyll before, you’ll need to install it first. Just follow the instructions here.

Running the local server

To preview the RoboFont documentation locally, you’ll need to have a local version of the robofont_com repository. Follow steps 1 & 2 of Editing the documentation to fork the repository and make a clone in your machine.

To start the local server, open the Terminal, go to the repository’s folder, and tell Jekyll to build the site on the preview server: