Skip to content

Carlos Documentation

This documentation is build with MkDocs using the Material for MkDocs theme.

Writing documentation

To write documentation you need a basic understanding of the markdown syntax. For some advanced usage we recommend having a look at Reference - Material for MkDocs.

Usage

Make sure to have python and poetry installed. To initialize your environment for this service run poetry install.

To show the documentation in your browser run the following command. Any updates done to the project will be automatically reloaded.

mkdocs serve

Deployment

To build the docs run

mkdocs build