Getting Started

This document explains how to build and preview the documentation locally using MkDocs, and provides an overview for contributors and plugin maintainers.

Prerequisites

• Python 3.8+ (for MkDocs)
• pip

Install MkDocs (recommended)

Run:

python -m pip install --upgrade pip
pip install mkdocs mkdocs-material

Build and serve locally

From the plugin root (where mkdocs.yml is located):

mkdocs serve

This serves the docs at http://127.0.0.1:8000 and rebuilds on change.

To build a static site:

mkdocs build -d site

The generated static site will be in the site/ directory.