Overview

The main website for the merc project, built using Zensical (a replacement for MkDocs) and hosted on GitHub Pages. It uses the Material theme for a modern design. First the submodules must be initialized and updated:

git submodule update --init

Then the required Python dependencies must be installed. Ideally using a virtual environment and the following command:

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 3rd_party/zensical-latex-math

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

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