Vous pouvez utiliser pandoc sur Linux pour convertir entre plus de 40 formats de fichiers. Vous pouvez également l’utiliser pour créer un système docs-as-code simple en écrivant dans Markdown, en le stockant dans git et en publiant dans l’un de ses formats pris en charge.
Table des matières
Conversion de documents et Docs-as-Code
Si vous avez un document dans l’un des pandoc de nombreux formats de fichiers pris en charge, le convertir en l’un des autres est un jeu d’enfant. C’est un outil pratique à avoir!
Mais la vraie puissance de pandoc devient évidente lorsque vous l’utilisez comme base d’un simple système docs-as-code. Le principe de la documentation en tant que code est d’adopter certaines des techniques et principes du développement logiciel et de les appliquer à la rédaction de la documentation, en particulier pour les projets de développement logiciel. Vous pouvez cependant l’appliquer au développement de tout type de documentation.
Les développeurs de logiciels utilisent leur éditeur préféré ou environnement de développement intégré (IDE) pour écrire leurs programmes. Le code qu’ils saisissent est enregistré dans des fichiers texte. Ceux-ci contiennent le code source pour le programme.
Ils utilisent un système de contrôle de version, ou VCS (Git est le plus populaire), pour capturer les modifications du code source au fur et à mesure de son développement et de son amélioration. Cela signifie que le programmeur a un historique complet de toutes les versions des fichiers de code source. Il ou elle peut accéder rapidement à n’importe quelle version précédente d’un fichier. Git stocke les fichiers dans un référentiel. Il existe un référentiel local sur l’ordinateur de chaque développeur et un référentiel central, partagé et distant, souvent hébergé dans le cloud.
Lorsqu’ils sont prêts à produire une version fonctionnelle du programme, ils utilisent un compilateur pour lire le code source et générer un exécutable binaire.
En écrivant vos documents dans un langage de balisage léger et basé sur du texte, vous pouvez utiliser un VCS pour contrôler la version de votre écriture. Lorsque vous êtes prêt à distribuer ou publier un document, vous pouvez utiliser pandoc pour générer autant de versions différentes de votre documentation que nécessaire, y compris sur le Web (HTML), traitement de texte ou composition (LibreOffice, Microsoft Word, Texas), Portable Document Format (PDF), livre électronique (ePub), etc.
Vous pouvez effectuer tout cela à partir d’un ensemble de fichiers texte légers contrôlés par version.
Installation de pandoc
Pour installer pandoc sur Ubuntu, utilisez cette commande:
sudo apt-get install pandoc
Sur Fedora, la commande dont vous avez besoin est la suivante:
sudo dnf install pandoc
Sur Manjaro, vous devez taper:
sudo pacman -Syu pandoc
Vous pouvez vérifier la version que vous avez installée à l’aide de l’option –version:
pandoc --version
Utiliser pandoc sans fichiers
Si vous utilisez pandoc sans aucune option de ligne de commande, il accepte également les entrées tapées. Vous appuyez simplement sur Ctrl + D pour indiquer que vous avez terminé de taper. pandoc s’attend à ce que vous tapiez au format Markdown, et il génère une sortie HTML.
Regardons un exemple:
pandoc
Nous avons tapé quelques lignes de Markdown et sommes sur le point d’appuyer sur Ctrl + D.
Dès que nous le faisons, pandoc génère la sortie HTML équivalente.
Cependant, pour faire quelque chose d’utile avec pandoc, nous devons vraiment utiliser des fichiers.
Principes de base de Markdown
Markdown est un langage de balisage léger, et une signification particulière est donnée à certains caractères. Vous pouvez utiliser un éditeur de texte brut pour créer un fichier Markdown.
Markdown peut être lu facilement, car il n’y a pas de balises visuellement encombrantes pour détourner l’attention du texte. Le formatage dans les documents Markdown ressemble au formatage qu’il représente. Voici quelques-unes des bases:
Pour mettre en valeur le texte en italique, entourez-le d’astérisques. * Cela sera souligné *
Pour mettre du texte en gras, utilisez deux astérisques. ** Ce sera en gras **
Les en-têtes sont représentés par le signe dièse / dièse (#). Le texte est séparé du hachage par un espace. Utilisez un hachage pour un en-tête de niveau supérieur, deux pour un deuxième niveau, et ainsi de suite.
Pour créer une liste à puces, commencez chaque ligne de la liste par un astérisque et insérez un espace avant le texte.
Pour créer une liste numérotée, commencez chaque ligne par un chiffre suivi d’un point, puis insérez un espace avant le texte.
Pour créer un lien hypertexte, mettez le nom du site entre crochets ([]) et l’URL entre parenthèses [()] ainsi: [Link to How to Geek](https://www.howtogeek.com/).
Pour insérer une image, tapez un point d’exclamation juste avant les crochets (![]). Tapez tout autre texte pour l’image entre crochets. Ensuite, mettez le chemin d’accès à l’image entre parenthèses [()“]. Voici un exemple:.
Nous couvrirons plus d’exemples de tout cela dans la section suivante.
Conversion de fichiers
Les conversions de fichiers sont simples. pandoc peut généralement déterminer les formats de fichiers avec lesquels vous travaillez à partir de leurs noms de fichiers. Ici, nous allons générer un fichier HTML à partir d’un fichier Markdown. L’option -o (sortie) indique à pandoc le nom du fichier que nous souhaitons créer:
pandoc -o sample.html sample.md
Notre exemple de fichier Markdown, sample.md, contient la courte section de Markdown présentée dans l’image ci-dessous.
Un fichier appelé sample.html est créé. Lorsque nous double-cliquons sur le fichier, notre navigateur par défaut l’ouvrira.
Maintenant, générons un Ouvrir le format de document document texte dans lequel nous pouvons ouvrir LibreOffice Writer:
pandoc -o sample.odt sample.md
Le fichier ODT a le même contenu que le fichier HTML.
Une touche soignée est que le texte alternatif de l’image est également utilisé pour générer automatiquement une légende pour la figure.
Spécification des formats de fichier
Les options -f (from) et -t (to) sont utilisées pour indiquer à pandoc les formats de fichier à partir desquels vous voulez convertir et vers. Cela peut être utile si vous travaillez avec un format de fichier qui partage une extension de fichier avec d’autres formats associés. Par exemple, Texas, et Latex tous deux utilisent l’extension «.tex».
Nous utilisons également l’option -s (standalone) afin que pandoc génère tout le préambule LaTeX requis pour qu’un document soit un document LaTeX complet, autonome et bien formé. Sans l’option -s (autonome), la sortie serait toujours du LaTeX bien formé qui pourrait être inséré dans un autre document LaTeX, il ne serait pas analysé correctement comme un document LaTeX autonome.
Nous tapons ce qui suit:
pandoc -f markdown -t latex -s -o sample.tex sample.md
Si vous ouvrez le fichier «sample.tex» dans un éditeur de texte, vous verrez le LaTeX généré. Si vous avez un éditeur LaTeX, vous pouvez ouvrir le fichier TEX pour voir un aperçu de la façon dont les commandes de composition LaTeX sont interprétées. Le rétrécissement de la fenêtre pour l’adapter à l’image ci-dessous donnait l’impression que l’écran était à l’étroit, mais, en réalité, c’était bien.
Nous avons utilisé un éditeur LaTeX appelé Texmaker. Si vous souhaitez l’installer dans Ubuntu, tapez ce qui suit:
sudo apt-get install texmaker
Dans Fedora, la commande est:
sudo dnf install texmaker
Dans Manjaro, utilisez:
sudo pacman -Syu texmaker
Conversion de fichiers avec des modèles
Vous commencez probablement à comprendre la flexibilité qu’offre pandoc. Vous pouvez écrire une fois et publier dans presque tous les formats. C’est un grand exploit, mais les documents ont l’air un peu vanille.
Avec les modèles, vous pouvez dicter les styles utilisés par pandoc lorsqu’il génère des documents. Par exemple, vous pouvez dire à pandoc d’utiliser les styles définis dans un Feuilles de style en cascade (CSS) avec l’option –css.
Nous avons créé un petit fichier CSS contenant le texte ci-dessous. Il modifie l’espacement au-dessus et au-dessous du style d’en-tête de niveau un. Il change également la couleur du texte en blanc et la couleur d’arrière-plan en une nuance de bleu:
h1 {
color: #FFFFFF;
background-color: #3C33FF;
margin-top: 0px;
margin-bottom: 1px;
}La commande complète est ci-dessous – notez que nous avons également utilisé l’option autonome (-s):
pandoc -o sample.html -s --css sample.css sample.md
pandoc utilise le style unique de notre fichier CSS minimaliste et l’applique à l’en-tête de niveau un.
Une autre option de réglage fin dont vous disposez lorsque vous travaillez avec des fichiers HTML consiste à inclure un balisage HTML dans votre fichier Markdown. Cela sera transmis au fichier HTML généré en tant que balisage HTML standard.
Cependant, cette technique doit être réservée lorsque vous ne générez qu’une sortie HTML. Si vous travaillez avec plusieurs formats de fichiers, pandoc ignorera le balisage HTML pour les fichiers non HTML, et il sera transmis à ceux-ci sous forme de texte.
Nous pouvons également spécifier les styles utilisés lors de la génération des fichiers ODT. Ouvrez un document LibreOffice Writer vierge et ajustez les styles d’en-tête et de police en fonction de vos besoins. Dans notre exemple, nous avons également ajouté un en-tête et un pied de page. Enregistrez votre document sous «odt-template.odt».
Nous pouvons maintenant l’utiliser comme modèle avec l’option –reference-doc:
pandoc -o sample.odt --reference-doc=odt-template.odt sample.md
Comparez cela avec l’exemple ODT précédent. Ce document utilise une police différente, a des en-têtes colorés et inclut des en-têtes et des pieds de page. Cependant, il a été généré à partir du même fichier Markdown «sample.md».
Les modèles de document de référence peuvent être utilisés pour indiquer les différentes étapes de la production d’un document. Par exemple, vous pouvez avoir des modèles comportant des filigranes «Brouillon» ou «À réviser». Un modèle sans filigrane serait utilisé pour un document finalisé.
Générer des PDF
Par défaut, pandoc utilise le moteur LaTeX PDF pour générer des fichiers PDF. La manière la plus simple de s’assurer que les dépendances LaTeX appropriées sont satisfaites est d’installer un éditeur LaTeX, tel que Texmaker.
C’est une installation assez importante, cependant – Tex et LaTeX sont tous les deux assez lourds. Si l’espace de votre disque dur est limité ou si vous savez que vous n’utiliserez jamais TeX ou LaTeX, vous préférerez peut-être générer un fichier ODT. Ensuite, vous pouvez simplement l’ouvrir dans LibreOffice Writer et l’enregistrer au format PDF.
Documents en tant que code
Il y a plusieurs avantages à utiliser Markdown comme langage d’écriture, notamment les suivants:
Travailler dans des fichiers de texte brut est rapide: ils se chargent plus rapidement que les fichiers de traitement de texte de taille similaire et ont tendance à se déplacer plus rapidement dans le document. De nombreux éditeurs, y compris gedit, Vim et Emacs, utilisent la coloration syntaxique avec le texte Markdown.
Vous aurez une chronologie de toutes les versions de vos documents: Si vous stockez votre documentation dans un VCS, tel que Git, vous pouvez facilement voir les différences entre deux versions du même fichier. Cependant, cela ne fonctionne vraiment que lorsque les fichiers sont en texte brut, car c’est ce avec quoi un VCS s’attend à travailler.
Un VCS peut enregistrer qui a apporté des modifications et quand: Ceci est particulièrement utile si vous collaborez souvent avec d’autres sur de grands projets. Il fournit également un référentiel central pour les documents eux-mêmes. De nombreux services Git hébergés dans le cloud, tels que GitHub, GitLab, et BitBucket, ont des niveaux gratuits dans leurs modèles de tarification.
Vous pouvez générer vos documents dans plusieurs formats: avec seulement quelques scripts shell simples, vous pouvez extraire les styles de CSS et de documents de référence. Si vous stockez vos documents dans un référentiel VCS qui s’intègre à Intégration continue et déploiement continu (CI / CD), ils peuvent être générés automatiquement à chaque fois que le logiciel est construit.
Dernières pensées
Il existe de nombreuses autres options et fonctionnalités dans pandoc que ce que nous avons couvert ici. Les processus de conversion pour la plupart des types de fichiers peuvent être modifiés et affinés. Pour en savoir plus, consultez les excellents exemples sur le site officiel (et extrêmement détaillés) page web pandoc.