NeSI docs template

Replace this readme with info about the site.

First Time Setup

You will need to have Python 3.10 or later installed on your computer.

Clone this repository and create a Python virtual environment using:

git clone https://github.com/nesi/nesi-mkdoc-template.git
cd nesi-mkdoc-template
python -m venv .venv
source .venv/bin/activate
pip3 install pip-tools
pip-compile
pip3 install -r requirements.txt

Build and deploy

source .venv/bin/activate
mkdocs serve -c

Take note of any warnings or errors.

A link to the deployment will be printed once served.

Developer Documentation

Following pages contain information to help maintain the documentation:

• See contributing (local version), to learn how to you can contribute.
• See formatting, for examples of markdown syntax.
• See create a new page, for general principles to consider when writing pages.
• See macros, for mkdocs-macros-plugin environment.
• See checks, for information on quality assurance tests.
• See workflows, for information on CI workflows.

Viewing PR Branches

Deployments of open pull requests can be viewed at https://callumwalley.github.io/support-docs-dev/NAME-OF-BRANCH

Theme

We are using the mkdocs material theme.

Analyics

Google Analytics can be set up.