Skip to content

SQUR Documentation

This directory contains the source code for the SQUR documentation, built with MkDocs and Material for MkDocs.

Prerequisites

  • Python 3.x
  • pip

Installation

  1. Navigate to the root of this repository (where mkdocs.yml is located).

  2. Install the required dependencies:

    bash python3 -m pip install mkdocs mkdocs-material

Development

To start the live-reloading development server:

python3 -m mkdocs serve

The documentation will be available at http://127.0.0.1:8000/.

Building

To build the static site (e.g., for deployment):

python3 -m mkdocs build

The output will be generated in the site/ directory.

Project Structure

  • docs/: Markdown source files.
  • mkdocs.yml: Configuration file.
  • docs/overrides: Custom HTML/CSS overrides.
? SQUR