Markdown : le guide du langage de balisage léger

Quand nous lisons des textes, que ce soit sur Internet, dans un magazine ou dans n’importe quel livre, nous nous attendons à une certaine mise en page. On utilise par exemple le gras pour mettre en avant des mots im­por­tants, on distingue au premier regard le titre d’un document et on utilise des pré­sen­ta­tions en forme de listes pour struc­tu­rer certaines parties du document. Un tel formatage nous paraît évident, et derrière notre clavier d’or­di­na­teur, lorsque nous rédigeons nos textes, tout cela ne nous pose aucun problème : nous changeons la taille des ca­rac­tères, nous insérons des tirets et mettons certains mots et ex­pres­sions en gras. N’importe quel trai­te­ment de texte offre à ses uti­li­sa­teurs de nom­breuses pos­si­bi­li­tés pour la mise en page des textes qu’ils éditent.

Pourtant tout n’est pas si simple. De votre côté, vous vous contentez de sé­lec­tion­ner le texte à formater, et votre logiciel lui donne les attributs que vous lui demandez. Avec les logiciels Word, vous ne voyez pas le véritable texte source, ac­com­pagné de ses balises. Et c’est tant mieux, à vrai dire : un tel texte est presque illisible pour un être humain.

N’importe quel éditeur de texte permet d’écrire du HTML ou du LaTeX, mais le résultat est dif­fi­ci­le­ment dé­chif­frable pour le commun des mortels. Et c’est exac­te­ment ce que le langage de balisage Markdown souhaite changer. Il veut tirer profit du meilleur des deux univers, et être compris à la fois des machines et des hommes. Pour mettre en forme le texte, Markdown utilise des éléments intuitifs. Dans ce cas, même le texte ac­com­pagné de ses balises sera assez facile à com­prendre pour les hommes.

Tout comme HTML ou LaTeX, Markdown est un langage de balisage. Con­trai­re­ment aux deux premiers langages, Markdown se veut être facile à lire par les personnes. Les balises ne doivent pas être abs­traites, mais proches de leur véritable sig­ni­fi­ca­tion. Le plus simple est d’illustrer notre propos par un exemple : pour mettre en gras un mot avec HTML, on utilise soit le '<b>'- soit la balise '<strong>'.

Si vous écrivez un docuement dans LaTeX, utilisez (en mode texte continu) l’élément \textbf.

Ces deux balises se lisent certes assez fa­ci­le­ment, mais sont plus dif­fi­ciles à écrire, par­ti­cu­liè­re­ment dans le cadre de la rédaction de longs textes. Markdown simplifie ce processus en mettant tout sim­ple­ment les éléments gras entre des étoiles.

Cette variante est d’une part plus lisible, car l’étoile indique fa­ci­le­ment la mise en gras, et vous aurez par ailleurs plus vite fait de taper quatre étoiles que des balises com­pli­quées. Avant la con­ver­sion (c’est à dire en Texte brut), un lecteur com­pren­dra ce qu’a voulu dire le rédacteur, même s’il ne maîtrise pas la syntaxe Markdown.

Markdown présente donc avant tout un intérêt pour tous ceux qui n’ont pas de com­pé­tence par­ti­cu­lière en in­for­ma­tique, ni en Webdesign, mais qui sont pourtant amenés à rédiger ré­gu­liè­re­ment des textes pour Internet. C’est le cas notamment des blogueurs qui utilisent un CMS (Content Ma­na­ge­ment System). Il arrive même à des spé­cia­listes et à des tech­no­philes de recourir au Markdown pour rédiger des textes simples. Certains pro­gram­meurs utilisent le langage Markdown pour rédiger par exemple des documents d’ac­com­pag­ne­ment (ex. les fichiers Readme) sans même les convertir au préalable. En termes de li­si­bi­lité, le résultat sera sen­si­ble­ment le même, que l’uti­li­sa­teur ouvre le texte dans un lecteur Markdown ou qu’il le lise à l’état brut.

Pour les CMS les plus courants comme WordPress et Joomla, il existe des plugins per­met­tant à ces logiciels de com­prendre le Markdown. Un bon nombre de wikis, de forums (Reddit par exemple), ainsi que le gé­né­ra­teur de site Jekyll sont capables d’in­ter­pré­ter ce langage de balisage simplifié.

Markdown ne cherche pas à se subs­ti­tuer à HTML. Les fonctions qu’il propose sont assez réduites. Pour les con­cep­teurs, le langage Markdown est plutôt un outil com­plé­men­taire. Il est d’ailleurs possible d’insérer des éléments HTML dans un document Markdown, ce qui élargit con­si­dé­ra­ble­ment le spectre de ce langage, plutôt simple à la base. L’objectif du langage Markdown est avant tout de vous sim­pli­fier les tâches d’écriture (en par­ti­cu­lier sur Internet). Une fois que les documents Markdown sont trans­for­més par l’analyseur syn­taxique (Parser en anglais), il en résulte des fichiers HTML sus­cep­tibles d’être utilisés avec les dif­fé­rents na­vi­ga­teurs.

Markdown étant conçu pour être un langage de balisage simple, la syntaxe Markdown est très intuitive. Pour pouvoir l’utiliser, vous devez cependant connaître les éléments de balisage. Nous avons réuni ci-dessous les prin­ci­pales fonctions.

Écrire en gras et en italique est par­ti­cu­liè­re­ment facile avec Markdown. Il suffit d’utiliser les étoiles, appelées aussi as­té­risques. Pour écrire en italique, insérez tout sim­ple­ment une étoile devant et derrière l’ex­pres­sion le mot ou concerné. Pour le gras, insérez deux étoiles avant et après. Pour le gras et l’italique, vous devrez opter pour trois étoiles. Une autre option consiste à utiliser les tirets bas.

Pour barrer un texte avec Markdown, précédez-le de deux tildes et refermez la chaîne avec deux autres tildes.

Par défaut, pour rédiger un titre avec Markdown, on utilise le dièse. On le sépare du texte avec une espace. Pour créer des sous-titres de hié­rar­chie in­fé­rieure, et donc rédigés en plus petits, il suffit d’insérer des dièses sup­plé­men­taires. Comme pour l’édition HTML, vous pourrez créer jusque 6 niveaux de sous-titres.

Une autre option consiste à utiliser le signe égal et le tiret pour délimiter les titres. Il suffit dans ce cas de les insérer en dessous de la ligne du titre. Cette variante ne permet cependant de créer qu’un titre et un seul niveau de sous-titre. Un seul caractère par titre suffit, bien qu’on ait tendance à en aligner plusieurs les uns derrière les autres. La raison est purement es­thé­tique. Plusieurs ca­rac­tères suc­ces­sifs donnent l’im­pres­sion d’un sou­lig­ne­ment simple ou double.

Le langage Markdown utilise des sauts de lignes pour créer des pa­ra­graphes séparés. Pour rédiger un nouveau pa­ra­graphe (balise

), il suffit d’insérer tout sim­ple­ment une ligne vierge. Attention cependant : Markdown considère comme ligne vierge toute ligne vide sur le plan purement visuel. Si cette ligne comprend des espaces in­vi­sibles, comme des ta­bu­la­tions ou des espaces, l’analyseur syn­taxique les ignorera et in­ter­pré­tera toute la ligne comme étant vierge. Si l’on souhaite insérer un saut de ligne cor­res­pon­dant à la balise
, il vous faudra insérer deux espaces à la fin d’une ligne.

Pour trans­for­mer une zone de texte en citation, il est possible de créer un élément de type Blo­ck­quote avec Markdown. Pour ce faire, vous uti­li­se­rez le signe supérieur à (>). Vous pourrez soit précéder chaque ligne de ce signe, soit en insérer un au début du pa­ra­graphe et terminer le pa­ra­graphe à mettre en exergue par une ligne vierge. D’autres éléments de formatage sont possibles dans un blo­ck­quote.

Si vous souhaitez établir une liste simple avec Markdown, vous avez le choix entre le signe plus, le tiret ou un as­té­risque. Ces trois options donnent le même rendu.

Pour créer une liste numérotée, il vous suffira d’inscrire un chiffre suivi d’un point.

Markdown permet aussi d’éditer des listes à cocher. Ces listes sont précédées d’une case à cocher pouvant être activée par clic. Ces cases peuvent d’ailleurs être cochées par défaut au moment de la création de la liste. Pour ce faire, vous devez utiliser les crochets et le X.

Pour écrire un morceau de code dans un texte, Markdown l’identifie au moyen du caractère appelé le Backtick ou apos­trophe inversée. Attention, à ne pas confondre avec les guil­le­mets. Le marquage est donc constitué d’une apos­trophe inversée au début et à la fin du segment cor­res­pon­dant au code. C’est ainsi que vous pourrez in­cor­po­rer di­rec­te­ment le code source ou une commande lo­gi­cielle dans le texte.

Si votre codage renferme déjà l’apos­trophe inversée, vous devez précéder la zone de code de deux fois ce caractère. Dans ce cas, Markdown n’in­ter­pré­tera pas l’apos­trophe inversée comme une balise.

Pour iden­ti­fier tout un bloc de texte comme du code source, vous pourrez utiliser soit la touche de ta­bu­la­tion ou quatre espaces con­sé­cu­tives, et ce pour chaque ligne concernée. Pour indenter davantage certaines lignes, il vous suffira d’insérer des ta­bu­la­tions ou des espaces.

Si vous préférez utiliser des ca­rac­tères pour in­tro­duire et refermer des blocs de codage, il est possible d’utiliser trois apos­trophes inversées au début et à la fin du bloc. Plusieurs éditeurs Markdown offrent par ailleurs la pos­si­bi­lité d’opter au­to­ma­ti­que­ment pour un balisage de couleur. Pour ce faire, il vous faut préciser, juste après les trois apos­trophes d'in­tro­duc­tion, le langage dans lequel vous avez édité le code source.

Markdown permet aussi d’insérer des images et des hy­per­liens dans votre texte. Cette insertion se fait en combinant des pa­ren­thèses et des crochets. Pour créer un lien, vous devrez écrire les mots ou les phrases visibles dans le texte entre crochets, suivis di­rec­te­ment de l’adresse URL entre pa­ren­thèses. Si vous souhaitez ajouter au lien un titre fa­cul­ta­tif, visible par l’uti­li­sa­teur au survol de la souris, c’est tout à fait possible : ce texte devra être ajouté à l’adresse URL entre les pa­ren­thèses, mais sera séparé d’une espace de l’URL, et inscrit entre guil­le­mets doubles.

Si vous insérez une adresse URL ou une adresse élec­tro­nique dans votre texte ordinaire, la plupart des éditeurs Markdown créeront au­to­ma­ti­que­ment un hyperlien ac­ces­sible par clic. Pour forcer cette fonction, utilisez les signes inférieur et supérieur à. Si, en revanche, vous souhaitez empêcher les éditeurs d’activer cette fonction, marquez l’URL comme code, et utilisez à nouveau les apos­trophes inversées.

La syntaxe per­met­tant d’insérer des images est semblable à celle des liens. On commence cependant par insérer un point d’ex­cla­ma­tion. Suivent ensuite les crochets entre lesquels on insère le texte al­ter­na­tif de l’image, puis l’URL de l’image entre pa­ren­thèses. L’image sera dans ce cas di­rec­te­ment affichée dans le texte.

Vous pouvez aussi combiner des images et des hy­per­liens. Si vous souhaitez insérer un lien cliquable derrière l’image, vous devez combiner les deux fonctions. L’image devient dans ce cas le texte d’ancrage et s’affiche donc entre les crochets.

Les barres ver­ti­cales (|) per­met­tent d’éditer des tableaux avec Markdown. Chaque cellule du tableau est séparée d’une barre verticale. Pour créer des lignes de titre qui se dis­tin­guent du reste du tableau, vous devrez souligner les cellules con­cer­nées avec les tirets du 6.

Il n’est pas né­ces­saire d’aligner les barres ver­ti­cales les unes en dessous des autres. Si elles sont alignées, la li­si­bi­lité du tableau est cependant meilleure dans la version brute du document Markdown. La même chose s’applique aux barres ver­ti­cales latérales. Elles n’ont aucune utilité pour la com­pi­la­tion du document.

Markdown vous permet aussi d’éditer des notes de bas de page. Ajoutez tout sim­ple­ment dans votre texte un numéro d’an­no­ta­tion, et reprenez ce numéro en bas de votre page dans une note de bas de page. Markdown créera alors au­to­ma­ti­que­ment une ligne. Le chiffre cor­res­pon­dant à l’an­no­ta­tion est au­to­ma­ti­que­ment formaté en lien, ce qui vous permet d’atteindre la note de bas de page par un simple clic. Pour pouvoir bé­né­fi­cier de cet au­to­ma­tisme, commencez par inscrire le numéro de l’an­no­ta­tion derrière le mot souhaité : commencez par écrire un accent cir­con­flexe entre les crochets, suivi du numéro.

Le choix du chiffre (ou autres valeurs) n’a aucune espèce d’im­por­tance. Comme pour la création de liste, Markdown se charge de la nu­mé­ro­ta­tion. Ce qui est important, c’est de créer ensuite un renvoi vers la dé­sig­na­tion que vous aurez sé­lec­tion­née. Pour ce faire, vous devez reprendre le même chiffre dans une nouvelle ligne, inséré à nouveau entre crochets avec un accent cir­con­flexe, vous ajoutez le signe des deux points, et vous rédigez le texte de l’an­no­ta­tion. Ce texte pourra d’ailleurs faire l’objet d’un formatage de votre choix, et s’étendre sur plusieurs lignes.

Et celles-ci com­pren­nent même plusieurs lignes

Markdown étant très proche de HTML, il convient de regarder de plus près à l’usage du « et com­mer­cial » ainsi que les signes supérieur et inférieur. Ces ca­rac­tères sont employés en HTML pour ouvrir et fermer des balises (<>) ou pour tra­vail­ler avec des entités (&). Si l’on veut utiliser ces ca­rac­tères dans leur sig­ni­fi­ca­tion d’origine, il faudra les masquer en HTML : &, < et >. Avec Markdown, il n’y a nor­ma­le­ment aucune raison de ne pas utiliser ces ca­rac­tères tels quels. Mais comme il est possible pour les uti­li­sa­teurs de combiner Markdown et HTML, la situation est un peu complexe. Pour vous éviter de devoir faire face à de tels problèmes, l’analyseur syn­taxique sait faire la dif­fé­rence entre les moments où vous souhaitez utiliser ces ca­rac­tères et les si­tua­tions de code HTML.

En plus des ca­rac­tères spéciaux imposés par HTML, Markdown utilise quelques autres ca­rac­tères pour le formatage. Si l’on insère ces ca­rac­tères, l’analyseur syn­taxique en tiendra compte au moment de la con­ver­sion. Voici les ca­rac­tères concernés :

• As­té­risque : *
• Trait d’union : -
• Souligné : _
• Pa­ren­thèses : ()
• Crochets : []
• Accolades : {}
• Point : .
• Point d’ex­cla­ma­tion : !
• Dièse : #
• Accent grave : `
• Barre oblique inversée : \

Si l’on veut utiliser ces ca­rac­tères dans leur sens premier, il suffit de les précéder d’une barre oblique inversée. Important : Cette barre oblique inversée doit im­pé­ra­ti­ve­ment précéder chacun de ces ca­rac­tères. Cela concerne donc autant une pa­ren­thèse ouvrante qu’une pa­ren­thèse fermante.

Ceci est un \*exemple avec des as­té­risques\*.