/algorea-devdoc

Developer doc for the Algorea project.

Primary LanguageHTMLCreative Commons Attribution 4.0 InternationalCC-BY-4.0

Developer Documentation for France-IOI Algorea

Code for auto-generated static website: https://france-ioi.github.io/algorea-devdoc/

Quick Start

The doc is auto-generated by Github pages at every push on master. If you want to run it locally:

  1. Install the Ruby Development Package: apt install ruby-dev
  2. Install Ruby and bundler (gem install bundler)
  3. Install the dependencies: bundle install
  4. Run it bundle exec jekyll serve (or build it once bundle exec jekyll build)

Initialize search data

bundle exec just-the-docs rake search:init

If using WSL on Windows, you might have to use bundle exec jekyll serve --force_polling to make auto update on file change work.

Style

For basic style (indent style, line break), make sure your editor support EditorConfig so that the one defined in this project is used by everybody.

For the text style, try to use markdown file as much as possible. Have a look at Just-the-docs documentation for ways to do custom styling.

Using navigation and search

Check how to do that with Just-the-Docs