Home

Build instructions

Requirements

• Git
• Ruby
• Jekyll
• Pandoc

The book HTML is converted from markdown using the Jekyll static site generator and the Pandoc document converter. To produce the book locally you first have to check out the git repo, go into the root folder of the repo and then do the following:

bundle install
bundle exec jekyll serve

After this command succeeds you can access the site at http://localhost:4000. The site is built in the folder ../openingscience.github.io/ (so that we can push to Github pages), but you can change the destination folder in the _config.ymlfile.

Pandoc is needed for formatting citations, and some Pandoc-specific markdown. The citation style used by Pandoc can be changed in config.yml.