Documentation

mkdocs-material¶

This project uses mkdocs-material to manage and dynamically generate documentation as a set of static websites.

To generate and view the compiled documentation locally, run the following within the activated poetry virtual environment:

mkdocs build

mkdocs serve

The admonitions extension is used to provide callouts. The list of available admonitions is available to customize callouts.

Examples:

!!! note
    This is a note.

Note

This is a note.

!!! warning
    This is a warning.

Warning

This is a warning.

The icon search page has a quick lookup of available icons that mkdocs-material supports.

[Send :fontawesome-solid-paper-plane:](#){ .md-button }