This repository contains the Pimidi documentation sources, based on MkDocs.
See the online version of the documentation here.
To serve the documentation locally:
-
Navigate to the project directory:
cd pimidi-docs
-
Install MkDocs and other dependencies:
pip install -r requirements.txt
-
Serve the documentation:
mkdocs serve
-
Open your browser at
http://127.0.0.1:8000
.
To build the static site:
mkdocs build
The site will be generated in the static
directory.
We welcome contributions! Please submit a pull request with your changes and improvements.