Repository files navigation

This is the repo for theDevelopers Handbook.

This handbook uses Jekyll, a static site generator written in Ruby. There are several options for setting up local development. Examples below illustrate the process using Bundler on a Debian-based system, or using a Docker container to keep things separate from the host system. After setup, the handbook will be available athttp://127.0.0.1:4000.

Although Jekyll is packaged in Debian, thegithub-pages gem is not, so Bundler is required to handle dependencies. It is not necessary toapt install jekyll.

Bundler requiresruby-dev andbuild-essential to build Ruby gem native extensions.

$ sudo apt install ruby-bundler ruby-dev build-essential$ bundle install$ bundleexec jekyll serve

Docker bind mounts the handbook source directory inside the container and marks it as private & unshared with any other container, before callingjekyll serve as in the instructions above.

$ docker run --rm --volume="$PWD:/srv/jekyll:Z" -it jekyll/jekyll jekyll serve

• Jekyll installation guidelines
• Ruby 101 notes