Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Lyon Living Lab Energy Documentation
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs help` - Print this help message.
## Setting files hierarchy
inside mkdocs.yml use the key nav: to configure the md files hierarchy
nav:
- Home: index.md
- Project Architecture:
- Introduction: architecture/architecture-home.md
- Client: architecture/client/client.md
- Cozy: architecture/cozy/cozy.md
- Konnectors:
- Readme: architecture/konnectors/readme.md
- Enedis: architecture/konnectors/enedis.md
- EGL: architecture/konnectors/egl.md
- GDRF - Celery: architecture/konnectors/gdrf.md
- About:
- Css: miscellaneous/css-recommandation.md
- Gitflow: miscellaneous/gitflow-ci-cd.md
- Glossary: miscellaneous/glossary.md
- Tools: miscellaneous/tools.md
- VSCode: miscellaneous/vscode-settings.md
## Project layout
mkdocs.yml # The main file and configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.