This documentation is fully written in Markdown. [MkDocs](https://www.mkdocs.org/) is used as well, so as to generate a beautiful static site out of this documentation.
*`mkdocs new [dir-name]` - Create a new project.
## MkDocs configuration
*`mkdocs serve` - Start the live-reloading docs server.
*`mkdocs build` - Build the documentation site.
MkDocs can be configured by editing the `mkdocs.yml` file. We refer the user to the [official MkDocs documentation](https://www.mkdocs.org/user-guide/) for futher information.
*`mkdocs help` - Print this help message.
## Running MkDocs with virtualenv
## Setting files hierarchy
inside mkdocs.yml use the key nav: to configure the md files hierarchy
The following commands allows one to setup a Python virtual environment, capable of running `mkdocs`:
nav:
```bash
- Home: index.md
$ python3 -mvenv venv
- Architecture Guide:
$ source venv/bin/activate
- Admin-gui: architecture/admin-gui.md
$ pip install-r requirements.txt
- Admin-tools: architecture/admin-tools.md
```
- Api-gateway: architecture/api-gateway.md
- CMS: architecture/cms.md
This project can then be built by issuing the following command: