Écrire tout simplement - Introduction à Markdown

Introduction

En tant que (apprenti-) chercheurs en SHS nous passons finalement une bonne partie de notre temps à taper à l’ordinateur :

• notes de lecture, de séminaire, de cours
• brouillons, réflexions diverses
• mails, billets de blog
• travaux de validation, comptes rendus, mémoires et thèses.

Quand je regarde autour de moi, que ce soit en séminaire ou en bibliothèque, je constate l’omniprésence du traitement de texte - Microsoft Word ou ses équivalents libres. Rares sont ceux qui prennent des notes dans des logiciels dédiés comme Evernote/Onenote etc., un peu plus fréquent déjà ceux qui consignent au moins leurs notes de lecture dans un logiciel de gestion bibliographique comme Zotero.
Une pratique dont les adeptes sont relativement rares en SHS, alors qu’elle est répandue dans les domaines plus techniques et souvent commentés sur des sites de productivité, c’est le texte brut, sans formatage qui suffit en fait pour beaucoup de besoins où le traitement de texte est de trop. Le texte brut a de très sérieux avantages sur le fichier de traitement de texte, en commençant par le risque bien moindre de corruption du fichier, en passant par la légèreté des fichiers obtenus, la pérennité du format et les possibilités d’accès et de modifications sur toutes plateformes, y compris téléphones portables. Mais quand on voudrait faire un minimum de mise en forme, passer quelques mots en italiques et indiquer des titres et sous-titres on atteint vite la limite du texte brut.
Il existe une solution intermédiaire qui permet un minimum de mise en forme, tout en gardant la simplicité et la facilité d’accès d’un fichier en texte brut. La syntaxe Markdown vaut à mon avis la peine d’être découvert et intégré dans vos procédés de travail.

Principes du markdown

Code html de ce billet

Les origines du markdown sont vite expliquées - l’idée était de créer un mode d’écriture pour le web qui évite d’avoir à insérer dès la première rédaction de véritables balises html.

L’objectif était donc un balisage minimal qui ne gène pas à la lecture du texte brut, mais qui peut facilement être converti en html pour le web, ainsi que dans des formats de traitement de texte pour d’autres usages. Voici ce que cela donne pour le début de ce billet :






L'export en html a permis le rendu que vous voyez en tant que billet de blog - et il est également possible de faire des conversions vers des formats .odt, .doc ou .pdf :

Vous comprenez donc aisément que le fichier de départ en texte brut avec son balisage très léger sert de point de départ souple à différents usages.
Après avoir découvert le markdown pour la rédaction de billets de blog dans le train hors connexion internet, je l’utilise de plus en plus pour toute une gamme de textes, surtout les notes diverses, débuts de textes communs avec collègues, notes pour mes enseignements etc.

Principaux éléments de syntaxe de formatage

En pratique, comment s’y prendre ? Il faut d’abord découvrir et retenir les éléments essentiels de balisage :

• pour les titres et sous-titres, il suffit de commencer la ligne avec un nombre décroissant de croisillons :

# Titre
## Sous-titre
### Intitulé de paragraphe

• pour les listes on peut choisir entre les puces qui s’obtiennent avec un + ou un - en début de ligne et les énumérations qui sont indiqués par un numéro en début de ligne

+ premier élément de la liste
+ deuxième élément

1. premier élément numéroté
2. deuxième élément numéroté

• à l’intérieur du texte un mot entouré d’asterisques simples ou de undescores apparaîtra en italiques alors qu’un mot entouré de deux astérisques ou de deux underscores apparaître en gras.

*en italiques* _en italiques_

**en gras** __en gras__


pour une citation, la convention est empruntée au mail :

> Ceci est une citation

Des conventions existent pour les liens autant internes qu’externes, pour l’intégration d’images etc., mais avec les quelques éléments ci-dessus on peut déjà couvrir la vaste majorité des besoins.

Quelques conseils - logiciels et documentation

La simplicité de la syntaxe markdown fait qu’elle peut s’écrire dans n’importe quel éditeur. Il existe cependant des outils spécialisés qui intègrent une interface de réaction en balisage markdown et des possibilités d’export en différents formats :

• sous Ubuntu j’utilise la plupart du temps ReText qui est doté d’une fonction de prévisualisation continue qui peut avoir son utilité

• sous mac, j’utilise souvent Byword, logiciel payant mais très esthétique, permettant une rédaction très agréable. Une solution gratuite existe avec Mou.
• sous Windows, j'aime bien WriteMonkey

Pour ceux qui voudraient d’abord s’essayer au balisage de markdown, il existe un grand nombre de sites web proposant des interfaces de rédaction et de visionnage du résultat en html comme le Dingus (voir ci-dessous) ou Pencil :

Pour finir, les liens vers quelques éléments de documentation pour aller plus loin :

• un billet introductif à markdown en anglais
• La syntaxe de markdown - éléments essentiels et version complète
• Quelques réflexions sur l'usage de markdown dans un contexte de recherche académique (voir aussi les commentaires).