umanit/doc-skeletor

UmanIT Doc Skeletor intends to ease documentation consistency amongst projects.

Doc Skeletor

, _(*1)

Doc Skeletor est outil de génération de structure de documentation unifiée au travers de tous les projets UmanIT., _(*2)

Installation

Depuis le répertoire de votre projet, lancez la commande suivante :, _(*3)

git clone https://github.com/umanit/doc-skeletor/ /tmp/doc-skeletor && cp -an /tmp/doc-skeletor/skeleton/. ./ && rm -rf /tmp/doc-skeletor

Un fichier readme.md et un répertoire _doc seront créés à la racine du projet, _(*4)

Note

Cet outil génère un squelette de doc mais celle-ci peut rester libre, vous pouvez modifier la structure et le contenu selon vos besoins, ceux-ci ne seront pas écrasés., _(*5)

Contribuer

Si vous constatez du boilerplate à rajouter au squelette, n'hésitez pas à créer des pull-requests., _(*6)