Skip to content

About

License

The source code of Qlementine is freely available on GitHub, and is licensed under the terms of the MIT License.

Authors

  • Olivier Cléro: Creator and main author. | email | website | github | gitlab
  • Christophe Thiéry: big contributor.
  • A big thanks to people at Abvent, where I gained experience on working on such a library, and people at Filewave, who trusted me by allowing me resources to improve this library.

MkDocs

Docs website setup

First, install mkdocs and some plugins:

pip install mkdocs-material
pip install mkdocs-git-revision-date-localized-plugin

To run the website locally, go to the website directory, then type:

mkdocs serve

Build

To build the website to the /public directory, ready to be deployed:

rm -rf ./public
mkdocs build --site-dir public

Docs CI

This documentation website is built automatically with the workflow docs.yml, and deployed to Github Pages.