Vendredi c'est Guides

gem install guides

Read The Fucking Manual!

Aujourd’hui une gem pour générer et maintenir de la documentation pour vos projets. Guides s’inspire de guides.rubyonrails.org pour l’interface.

Pour créer un nouveau guide, on commence comme ceci :

guides new nomduprojet

Ensuite vous allez éditer le fichier guides.yml pour y ajouter des sections et articles :

index:
  Section:
    - title: Texte du lien vers l'article
      url: nom_du_fichier_correspondant_sans_extension
      text: Une description du lien

Enfin il ne vous reste qu’à utiliser soit .textile soit .md pour les fichiers correspondants aux articles et voilà :)

Pour visualiser votre guide :

guides preview

Et pour générer une version déployable :

guides build

C’est tout pour aujourd’hui.

Le lien utile

• Guides sur github