The documentation for this project is handled by Read the Docs, a web service dedicated to documentation management for the open source community.
By default, the Falkor/dotfiles
repository is bound to the falkor-dotfiles project on Read the Docs (to avoid confusion with other dotfiles
projects).
You might wish to generate locally the docs:
- Install
mkdocs
- Preview your documentation from the project root by running
mkdocs serve
and visit with your favorite browser the URLhttp://localhost:8000
- build the full documentation locally (in the
site/
directory) by runningmkdocs build
.