The official documentation for Mergado Apps platform which is build with GitHub Pages.

First, you need to install Jekyll which can be done via RubyGems. If you don't have RubyGems installed (the command whereis gem should return tha path to the RubyGems' binary), follow this guide. Otherwise, run the following command:

$ gem install jekyll

For more information on how to install Jekyll, see the official documentation.

After you have installed Jekyll, clone the repository with git:

$ git clone git@github.com:mergado/docs.git

Usually, you only need to run the following command which generates HTML files into ./_site:

$ jekyll serve

This command also runs a built-in development server (at http://localhost:4000/ by default). For more information follow the official documentation.

If you want to create a new section to appear in the navigation, edit the _config.yml in root and run the command for creating a new page, for example:

$ ruby bin/jekyll-page "Authentication" api