# Lyon Living Lab Energy Documentation

## Commands

* `py -m pip install mkdocs` - Install mkdocs
* `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:
            - Introduction: architecture/konnectors/konnectors-intro.md
            - Enedis: architecture/konnectors/enedis.md
            - EGL: architecture/konnectors/egl.md
            - GDRF: architecture/konnectors/gdrf.md
    - About:
        - Gitflow: miscellaneous/gitflow.md
        - Glossary: miscellaneous/glossary.md
        - Tools: miscellaneous/tools.md
        - Environment: miscellaneous/devenv.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.

## Mkdocs packages

    py -m pip install mkdocs-material
    py -m pip install plantuml-markdown