Skip to content
Snippets Groups Projects
Commit 41459377 authored by Hugo NOUTS's avatar Hugo NOUTS
Browse files

init commit

parents
No related branches found
No related tags found
No related merge requests found
# 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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment