Arborescence du dossier docs

La documentation d'un plugin doit être dans le repertoire /docs du plugin.

Celui-ci est composé, a minima, des sous répertoires et fichiers suivants:

_layouts : layout de la documentation (ie entete,marque page,..), gérer par la robot Jeedom ??

assets : contient la font, le css.. de la documentation, gérer par la robot Jeedom ???

fr_FR: c'est ici que vous faites votre documentation dans un fichier index.md (format markdown) et dans un fichier changelog.md, les notes de versions.

images : les images, screenshot que vous voulez ajouter à vos fichiers markdown (ie index et changelog)

404.html : contient la page de redirection en cas d'erreur, gérer par le robot Jeedom,

_config.yml : gérer par le robot Jeedom,

index.html : page de redirection,

Intégration Jeedom

Pour indiquer à Jeedom le chemin de la documentation, il faut insérer dans le fichier /plugin_info/info.json les lignes suivantes:
"changelog" : "https://jeedom.github.io/plugin-<id du plugin>/#language#/changelog"
"documentation" : "https://jeedom.github.io/plugin-<id du plugin>/#language#/"

Des repertoires tel que es_ES, en_US,... seront créer automatiquement lors du passage du robot de traduction.

En conclusion, la documentation est dans le repertoire /docs/fr_FR dans des fichiers de type markdown, et vos images pour la documentation dans le répertoire /docs/images.

Création ou modification des docs vers nouveau standard de la team

Activé les pages pour votre repo

Allez dans les settings de votre repo

Allez tout en bas jusqu’à la section "Pages Github"

Ensuite dans source, sélectionner master branch /docs folder

Cliquez sur save

Installer les pages dans votre repo

Si vous mettez à jour votre plugin

Dans le plugin-template de la team ici, récupérez les fichiers suivants dans le répertoire /docs et copiez les dans les repertoires docs de votre repo.

• index.html
• config.yml
• 404.html

Faites de meme pour les repertoires suivants:

• assets
• _layouts

Pour finir dans le répertoire fr_FR il doit y avoir le fichier index.md d'origine et le fichier changelog.md , il ne suffit plus qu'a modifier quelques éléments (voir section suivante pour la modification du fichier index.md).

Si vous installez les docs pour la 1ere fois

Copier tout le repertoire docs du plugin-template de la team ici dans votre repo et modifier le fichier index et le fichier changelog du repertoire /docs/fr_FR

modification du fichier index.md

les chapitres doivent être construits de la façon suivantes:

Description

===

les 3 "égales" permettent de changer de chapitres.

rendu: