Skip to content

Alan Backend Documentation

This site is built with MkDocs ⧉.

Running locally

Make sure you are at the root of the backend directory (alan-apps/backend) and run mkdocs serve

[!TIP] To speed things up, you can comment all the components you don't need to build in the nav section of backend/mkdocs.yml

Adding a component / section

New components' documentation are not discovered and built automatically. You need to add the reference to its main mkdocs.yml file in the nav/Components section of backend/mkdocs.yml. The local server will automatically reload the whole site.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server on http://127.0.0.1:8000 ⧉
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.