Development #23667
Documentation des spécificités des thèmes
0%
Description
Sur des intégrations spécifiques on se trouve généralement à attribuer des identifants et des classes CSS aux différents blocs mais c'est rarement documenté, au mieux ça se trouve dans un mail annonçant la mise à disposition de l'intégration graphique.
D'une discussion récente il y a eu l'idée d'améliorer ça, et pour aller au plus proche du code, pour éviter l'obsolescence d'un texte écrit ailleurs, on pourrait inclure ça directement dans les .scss.
Sur un mode doxygen/gtk-doc/etc. on pourrait commencer les commentaires de documentation par /** mais ceux-ci sont repris dans le css compilé; on peut donc imaginer faire la variante //*.
Ci-joint un exemple pour Nancy, discutons du sujet, convenons d'une syntaxe, ensuite on pourra développer les petits outils autour pour publier cette info.
Fichiers
Historique
Mis à jour par Anonyme il y a presque 6 ans
Un outil qui semble pratique c'est http://sassdoc.com/
Malheureusement installable via npm, mais on peut documenter du code sass en utilisant des annotations standards (http://sassdoc.com/annotations/) et publier une page de docs automatiquement.
Mis à jour par Frédéric Péters il y a presque 6 ans
Ok pour reprendre leur méthode de commencer ces lignes par ///, et de définir que le contenu est du markdown. Mais de là je n'irais pas plus loin, mon intention est vraiment une documentation à destination de l'administrateur fonctionnel, là où sassdoc me semble plutôt concerner les personnes qui éditent/maintiennent les fichiers scss.