Contrib présente les documentations des plugins communautaires. Vous êtes donc invités à y créer un article de documentation du plugin que vous souhaitez partager.
Pour cela, vous pouvez consulter la documentation rédacteur. Mais cet article peut aussi simplement reprendre le fichier README.md qu’en tant que développeur du plugin, vous aurez créé à la racine du repo du plugin.
README.md dans le repo de votre plugin
Le site contrib.spip.net met un modèle readme à disposition pour documenter un plugin de la forge git grâce à son fichier README.md. Cela permet d’éviter de maintenir la documentation à deux endroits différents.
Syntaxe de base
L’insertion du modèle suivant dans le texte de l’article prend le README.md du dernier tag du plugin dont le préfixe est voir_motdepasse
<readme|plugin=voir_motdepasse>
Autre possibilité, si le tag n’est pas encore posé ou si on souhaite avoir le README.md d’une branche précise :
<readme|plugin=voir_motdepasse|branche=master>
Forcer une mise à jour
Pour forcer une mise à jour, il faut appeler la page avec ?var_mode=calcul (et non recalcul...)
Comment ajouter des captures d’écrans
Les captures d’écrans peuvent être ajoutés dans le README.md mais il faut éviter de les distribuer dans les zips des plugins distribués
Il faut donc :
– déposer les captures dans un répertoire docs/images
– déposer les fichiers en LFS (Large File System)
git lfs track "\*.png,\*.jpg"
– ajouter dans .gitattributes
*.png filter=lfs diff=lfs merge=lfs -text
*.jpg filter=lfs diff=lfs merge=lfs -text
Exemple :
https://git.spip.net/spip-contrib-extensions/voir_motdepasse/-/merge_requests/2