ZEV Plus Documentation

This documentation is built with MkDocs and maintained in a dedicated repository:

• Repository: https://github.com/energie-plus/general-docs
• Live version: https://docs.zevplus.ch

To run the documentation locally:

mkdocs serve

Then open http://localhost:8000 in your browser.

Contributing

1. Clone the repository:

git clone https://github.com/energie-plus/general-docs

1. Edit the Markdown files locally.

2. Preview your changes:

mkdocs serve

1. Verify your changes at http://localhost:8000

2. Commit your changes and push them to the repository.

Note: Direct commits to main should be avoided. Use pull requests if possible.

Access

The documentation is available at https://docs.zevplus.ch. Access is restricted to registered users.

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Admonition Guidelines

This project uses MkDocs Material admonitions to highlight important information.

Recommended Usage

Type	Use Case
note	General notes or additional context
info	Technical background information
tip	Helpful hints or best practices
warning	AI-generated or not yet reviewed content
danger	Potentially destructive or production-critical actions
bug	Known issues, limitations, or unexpected behavior
example	Configuration or implementation examples

Examples

Warning

!!! warning "AI generated content"
    The text below was generated by AI and not yet reviewed.

Danger

!!! danger "Production Environment"
    Do not run this command on a live production system.

Tip

!!! tip
    Use `docker compose logs -f` for live container logs.

Collapsible Blocks

Collapsible admonitions can be created with ???.

??? info "Advanced configuration"
    Additional details here.