The developer documentation is created using the Jekyll Theme Just the Docs.

For local development, follow the Jekyll installation instructions. Installing the latest version of ruby followed by gem install bundler should be enough.

Afterwards, run

bundle install
jekyll serve --livereload

and go to http://localhost:4000/ in your browser.

On Windows, using a dockerized environment is recommended:

docker build . -t jrjekyll
docker run -p 4000:4000 -it --rm --volume="C:\git-repositories\jabref\docs":/srv/jekyll jrjekyll jekyll serve -H 0.0.0.0 -t

• With Ctrl+C you can stop the server (this is enabled by the -it switch).
• In case you get errors regarding Gemfile.lock, just delete Gemfile.lock and rerun.
• The current Dockerfile is based on https://github.com/just-the-docs/just-the-docs/blob/main/Dockerfile. The Jekyll Docker image did not work end of 2022 (because Ruby was too new).

You can execute the linting action as if it was executed by GitHub by executing following command.

act --rm --platform ubuntu-latest=fwilhe2/act-runner:latest -W .github/workflows/tests.yml -j "markdown"

That command uses act, which brings GitHub actions execution to the developer machine.