DOCUMENTATION.md

AirLink documentation

This page describes how to get started with contributing to the documentation.

Pre-requisites

• MkDocs
• MkDocs-material

For example using pipx:

pipx install mkdocs
pipx inject mkdocs mkdocs-material

Build the documentation

mkdocs serve

Then open docs in a local web browser.

Writing documentation

To make the documentation easy to read and comprehend Material for Mkdocs provides as set of enhanced Markdown features.

See a list of examples here: Reference