Overview

The main website for the merc project, built using MkDocs and hosted on GitHub Pages. It uses the Material theme for a modern design. First of all, the require Python dependencies must be installed. Ideally, this is done in a virtual environment.

pip install -r requirements.txt

Furthermore, we use a latex-math MkDocs plugin to render LaTeX equations in the documentation. During development it can be useful to install packages as editable using the following command:

pip install -e requirements.txt

The documentation can be then be served locally or built using the following commands:

• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.