Contribute to the teaching material
This website is stored as a project site Github page and is stored on the CERG-C github repository. The documentation is written in Markdown, and built into a website using the static website generator MkDocs with the Material for MkDocs theme. Building and deploying the website requires some knowledge of Python and Git.
Installing the website
It is recommended to setup the website in a Conda environment rather than on the system's Python distribution.
Setting up an environment
Installing dependencies
Contributing to the course
Markdown native
Library-specific
- Citations/references: As footnotes
- Abbreviations:
Deploying the website
We use mike to keep track of versions. The active version is always set with the latest label, so make sure it is set by default. From the root of the CERG-C repository, run from the terminal:
mike set-default latest
When working on a new version, push the website using a dummy label - here test.
mike deploy --push --update-aliases 2022.1 test
When happy with your changes, use the latest label.
mike deploy --push --update-aliases 2022.1 latest
Different versions are accessible with their version numbers. For instance, the url of version 2022.1 is https://cerg-c.github.io/CERG-C/2022.1/.
Keep track of versions!
Log the purpose of the versions here!
Old website version
The website was initially stored as an organisation site Github page in the repo CERG-C.github.io, for which deployment was done with:
mkdocs gh-deploy --force --remote-branch main --config-file mkdocs.yml