Hello everyone,
Documenting our change in Home Assistant configuration is always a good practice.
To do so, BookStack add-on is proposed in add-ons store. I find this solution too heavy for such a small documentation. I think that MkDocs, which is a simple and efficient tool for generating documentation, is much better suited to meet my needs.
So, I looked for an MkDocs add-on but unfortunately, I didn’t find one 
… so, I decided to develop it myself 
.
I am pleased to present version 1.0.0 of the MkDocs add-on for Home Assistant.
Installation of this add-on
To install the MkDocs add-on, you first need to add the URL of its repository to your Home Assistant instance. To do this, click the following button
or manually add the following repository URL in the Home Assistant add-on store:
https://github.com/XavierBerger/home-assistant-addons
Next, search for one of the add-ons in our add-on store (button below) to install them.
Editing documentation
To edit your documentation, it is recommended to use the Visual Studio Code Server add-on available in the add-on store.
You will then need to open the directory /addon_configs/18ac940c_mkdocs and edit the files it contains: mkdocs.yml for the table of contents and configuration of your documentation and the markdown files stored in the docs directory for the content.
For more information on writing your documentation, you can refer to the following guides:
- MkDocs User Guide: The core of this add-on.
- Markdown Guide: Details of Markdown syntax.
- Material for MkDocs Reference: Additional features provided by Material for MkDocs.
- PlantUML Website: A tool for creating diagrams.
- Draw.io: A tool for creating diagrams (Check the Help and FAQ directly available in the add-on’s sample documentation for installation and use in VSCode).
For tips and advice on using this add-on, check out the Help and FAQ directly available in the add-on’s sample documentation.
Feel free to give me your feedback and comments here, this is the first public version and there are certainly things to improve.
A little demo to finish:
