Terarium Help Documentation

This repository contains all the necessary files to build and store the help documentation for Terarium. The Terarium help site builds with MkDocs and the Material for MkDocs theme.

Prerequisites

Before you begin, make sure you a recent version of Python and the Python package manager, pip.

Installing MkDocs and the Material theme

The help is designed to build with the latest MkDocs and Material theme. It also uses a few extensions provide additional functionality:

• mkdocs-glightbox enables zoom functionality for images.
• mkdocs-macros-plugin allows the use of variables in Markdown files.
• mkdocs-print-site-plugin creates a single page with all site content so that it can be exported to PDF.

To install the latest MkDocs, theme, and extensions:

pip install mkdocs
pip install mkdocs-material
pip install mkdocs-glightbox
pip install mkdocs-macros-plugin
pip install mkdocs-print-site-plugin

Building the help site

To build the Terarium help site, run the following command in the root folder:

mkdocs build -d <dest_folder>

To build a local development version of the site, run the following command in the root folder:

mkdocs serve

The development server will be at http://localhost:8000/.