Executable Research Compendium (ERC) specification and guides
Project description: https://o2r.info
Read online: https://o2r.info/erc-spec
mkdocs to render it locally.
# pip install mkdocs mkdocs-cinder pymdown-extensions mkdocs serve
Our combination of the
.deploy.sh will run the
mkdocs command on every direct commit or merge on the master branch and deploy the rendered HTML documents to the
gh-pages branch in this repository.
Travis authenticates its push to the
gh-pages branch using a personal access token of the user @o2r-user, who has write access to this repository.
The access token is encrypted in the
.travis.yml using Travis CLI:
travis encrypt GH_TOKEN=<token here>
GH_TOKEN is used in the deploy script.
The token generated on the GitHub website should not be stored anywhere, simply generate a new one if needed.
This has some security risks, as described here. To mitigate these risks, the option "Build pull requests" on the Travis configuration page for this repo must be disabled so malicious changes to the Travis configuration file will not be build before maintainer inspection.
The o2r Executable Research Compendium specification is licensed under Creative Commons CC0 1.0 Universal License, see file
To the extent possible under law, the people who associated CC0 with this work have waived all copyright and related or neighboring rights to this work.
This work is published from: Germany.