Asciidoc et Asciidoctor pour soigner votre documentation

Magazine
Marque
GNU/Linux Magazine
Numéro
190
Mois de parution
février 2016
Spécialité(s)


Résumé
La rédaction de documentation pour un projet est souvent reléguée au second plan, « on s'en occupera plus tard », voire carrément ignorée. Ce qui est très malheureux, surtout quand on est soi-même prompt à pester contre ce manque de documentation lorsque l'on récupère le projet d'un collègue ou que l'on arrive sur un nouveau poste. Plus qu'un manque de temps, c'est souvent les outils qui font défaut, et nous rebutent à nous lancer dans le processus de rédaction. Vous vous êtes d'ailleurs peut-être tourné vers Markdown, attiré par sa simplicité, mais limité, car trop simpliste.

Dans cet article, nous allons découvrir Asciidoc et Asciidoctor : comment simplement convertir un fichier source au format Asciidoc en un document HTML et PDF.

Asciidoc [1] est un langage de balisage léger qui vous permet de rédiger vos documents, en les structurant à l'aide de caractères ASCII (*, _, =, ...), pour les générer en différents formats : pages web, e-books, etc.

Pourquoi Asciidoc et pas un éditeur WISYWIG comme LibreOffice ou OpenOffice? Parce qu'avec Asciidoc vous n'avez pas besoin d'apprendre, ni de vous perdre dans les menus d'un éditeur lourd. Parce qu'avec Asciidoc vous travaillez au format texte, l'édition de documents Asciidoc s'intègre donc de manière transparente dans votre flux de travail à l'aide de vos outils courants, surtout si…

Cet article est réservé aux abonnés. Il vous reste 91% à découvrir.
S'abonner à Connect
  • Accédez à tous les contenus de Connect en illimité
  • Découvrez des listes de lecture et des contenus Premium
  • Consultez les nouveaux articles en avant-première
Je m'abonne


Article rédigé par

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous