About This MkDocs Site

This is a new page created by Dean. This site was setup by our amazing ops team of Neal, Kenny, and Amanda.

Getting Started with MkDocs

For full documentation visit mkdocs.org.

Installation

There are two ways to run the development server: from Docker or from the command line. Running from the command line requires a working Python and pip installation, while running from a Docker container requires a Docker-compatible system with Docker or Docker Desktop installed.

Running in Docker

This is the easiest option if you already have a working Docker installation. Simply run the following command from the project's root directory:

• docker compose up -d

This will run a live development server on http://localhost:8000/ that will automatically update the web site as you make edits.

Running From the Command Line.

Run the following commands to install the mkdocs tooling.

• pip install mkdocs - Install the mkdocs utility.
• pip install mkdocs-material - Install the third-part Material theme.

Now you can use the following mkdocs commands during development.

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Editing This Documentation

Simply clone the GitLab repo and start editing these markdown pages.

Use the mkdocs serve command shown above to start a development server to live-reload your changes as you make edits.

When you push changes to the main branch, GitLab will automatically build and deploy your changes.