Skip to content
Snippets Groups Projects
README.md 1.52 KiB
Newer Older
  • Learn to ignore specific revisions
  • Hugo NOUTS's avatar
    Hugo NOUTS committed
    # Lyon Living Lab Energy Documentation
    
    ## Commands
    
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    * `py -m pip install mkdocs` - Install mkdocs
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    * `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
    
    Yoan VALLET's avatar
    Yoan VALLET committed
        - Getting started:
            - Setup your environment: getting_started/setup_your_environment.md
            - Launch the application on local : getting_started/launch_local_application.md
            - Launch a konnector on local : getting_started/launch_local_konnector.md
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
        - Project Architecture:
    
    Yoan VALLET's avatar
    Yoan VALLET committed
            - Architecture : project_architecture/architecture.md
            - Cozy : project_architecture/cozy.md
            - Environments : project_architecture/environments.md
            - DocTypes : project_architecture/doctypes.md
        - Application:
            - Description: application/description.md
            - Gitflow: application/gitflow.md
        - Konnectors:
            - Enedis: konnectors/enedis.md
            - GRDF: konnectors/grdf.md
            - Eau du Grand Lyon: konnectors/egl.md
        - Proxy:
            - Description: proxy/description.md
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    ## Project layout
    
        mkdocs.yml    # The main file and configuration file.
        docs/
            index.md  # The documentation homepage.
            ...       # Other markdown pages, images and other files.
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    ## Mkdocs packages
    
        py -m pip install mkdocs-material
        py -m pip install plantuml-markdown