Bonjour à tous,
Parmi les huit conseils prodigués dans sa vidéo 8 erreurs courantes en domotique et comment les éviter !, @Howmation conseil de documenter ses modifications et ses configurations faites sur Home Assistant.
Je suis tout à fait d’accord avec ce conseil.
La solution proposée est d’utiliser l’add-on BookStack. Je trouve cette solution trop lourde pour une si petite documentation. Je pense que MkDocs, qui est un outil simple et efficace pour générer de la documentation, est bien mieux adapté pour répondre à mes besoins.
J’ai donc cherché un add-on MkDocs mais malheureusement, je n’ai pas trouvé 
… alors, je me suis dit que j’allais le développer 
.
Je vous présente donc la version 1.0.0 de l’add-on MkDocs pour Home Assistant
Installation de cet add-on
Pour installer MkDocs add-on, vous devez d’abord ajouter l’URL de son dépôt à votre instance Home Assistant. Pour ce faire, cliquez sur le bouton suivant
ou ajoutez manuellement l’URL de dépôt suivante dans le magasin d’add-ons Home Assistant :
https://github.com/XavierBerger/home-assistant-addons
Ensuite, recherchez l’un des add-ons dans notre magasin d’add-ons (bouton ci-dessous) pour les installer.
Édition de documentation
Pour éditer votre documentation, il est recommandé d’utiliser l’add-on Visual Studio Code Server disponible dans le magasin d’add-ons.
Vous devrez ensuite ouvrir le répertoire /addon_configs/18ac940c_mkdocs et éditer les fichiers qu’il contient : mkdocs.yml pour la table des matières et la configuration de votre documentation et les fichiers markdown stockés dans le répertoire docs pour le contenu.
Pour plus d’informations sur l’écriture de votre documentation vous pouvez vous référé aux guides suivants :
- Guide utilisateur MkDocs : Le cœur de cet add-on.
- Guide Markdown : Détails de la syntaxe Markdown.
- Référence Material for MkDocs : Fonctionnalités supplémentaires fournies par Material for MkDocs.
- Site web PlantUML : Un outil pour créer des graphiques.
- Draw.io: Un outil pour créer des diagrammes (Consultez l’Aide et la FAQ directement disponible dans la documentation d’exemple de l’add-on pour l’installation et l’utilisation dans VSCode)
Pour des astuces et des conseils sur l’utilisation de cet add-on, consultez l’Aide et la FAQ directement disponible dans la documentation d’exemple de l’add-on.
N’hésitez pas à me faire vos retours et commentaire ici, c’est la première version publique et il y a certainement des choses à améliorer.
Une petite démo pour terminer:
