https://doi.org/10.46430/phfr0007Contenus
Objectifs de la leçon
Cette leçon sert d’initiation à Markdown, qui est une syntaxe en texte brut pour le formatage de documents. Vous allez découvrir pourquoi l’utiliser, comment formater des fichiers Markdown et comment prévisualiser de tels fichiers sur le web.
Puisque les tutoriels de ce site sont soumis sous forme de fichiers Markdown, je mobilise des exemples maison chaque fois que cela est possible. J’espère que ce guide vous sera particulièrement utile si vous envisagez de rédiger un tutoriel en tant qu’auteur(e) pour le Programming Historian, même s’il reste d’une portée plus générale.
Qu’est-ce que le Markdown?
Développé en 2004 par John Gruber, Markdown est à la fois un langage de balisage de fichiers textes et une fonctionnalité du langage Perl permettant de convertir des fichiers Markdown en HTML. Notre leçon traite davantage du premier aspect, puisque nous apprendrons à utiliser la syntaxe Markdown pour préparer des fichiers.
Les fichiers texte brut présentent plusieurs avantages comparés aux autres formats. Non seulement ils sont compatibles avec tout type d’appareil et de système d’exploitation, mais ils s’avèrent aussi plus pérennes. Si jamais vous avez tenté d’ouvrir un document sauvegardé dans une version antérieure d’un logiciel de traitement de texte, vous pouvez comprendre facilement les problèmes de compatibilité qui sont en jeu.
L’utilisation de la syntaxe Markdown vous permettra de produire des fichiers à la fois lisibles en texte brut et prêts à recevoir davantage de traitement sur une autre plateforme. Plusieurs systèmes de gestion de blogs, des générateurs de sites web statiques ou encore des plateformes comme GitHub prennent en charge des fichiers Markdown pour les convertir en HTML et les publier sur le web. De plus, des outils comme Pandoc peuvent convertir des fichiers depuis et vers Markdown. Pour apprendre plus sur Pandoc, vous pouvez faire un tour sur cette leçon de Dennis Tenen et Grant Wythoff.
La syntaxe Markdown
Les fichiers Markdown portent l’extension .md. Il est possible de les ouvrir avec un éditeur de texte comme TextEdit, Notepad++, Sublime Text ou Vim. Plusieurs sites web et des plateformes de publication proposent des éditeurs de texte en ligne et/ou des extensions pour insérer du texte avec la syntaxe Markdown.
Dans ce tutoriel, nous allons pratiquer la syntaxe Markdown directement depuis notre navigateur préféré en utilisant l’éditeur en ligne StackEdit. Cet éditeur de traitement vous permet d’insérer du texte formaté en Markdown à gauche et en avoir le rendu directement à côté, à droite.
Puisque toutes les leçons du Programming Historian sont écrites en Markdown, nous pouvons aussi explorer ces fichiers avec StackEdit. Ainsi, l’URL suivante fait apparaître la leçon “Préserver ses données de recherche” en Markdown:
https://raw.githubusercontent.com/programminghistorian/jekyll/gh-pages/fr/lecons/preserver-ses-donnees-de-recherche.md
Une fois sur la fenêtre de l’éditeur StackEdit, à partir de l’adresse indiquée ci-dessus, copiez l’ensemble du texte puis collez-le dans le panneau de gauche de l’éditeur. Si vous le préférez, après avoir copié le texte, vous pouvez aussi le coller dans un nouveau fichier en utilisant un éditeur de texte de votre choix puis le sauvegarder en format .md sur votre poste de travail. Ensuite, rendez-vous sur l’éditeur de StackEdit et cliquez sur #, en haut à droite, pour accéder au menu puis choisissez Import Markdown (Importer Markdown). Spécifiez le chemin pour accéder au fichier que vous avez stocké en local, puis ouvrez-le.*
Vous remarquez que, même si la fénêtre à droite offre un rendu plus élégant du texte, le fichier initial en Markdown, à gauche, reste bien lisible.
Maintenant, démarrons notre leçon pour rédiger notre propre syntaxe Markdown. Veuillez créer un nouveau document dans StackEdit en cliquant sur l’icône en haut à gauche et en choisissant New Document (Nouveau document). Vous pouvez introduire un titre pour le document dans la boîte de texte en haut de la page.
En-têtes
Il y a quatre niveaux d’en-têtes disponibles en Markdown; ils sont indiqués par le nombre de # précédant le texte de l’en-tête. Merci de copier et coller les exemples suivants dans la boîte de texte à gauche.
# En-tête de premier niveau
## En-tête de deuxième niveau
### En-tête de troisième niveau
#### En-tête de quatrième niveau
Les en-têtes de premier et de deuxième niveau peuvent aussi être signalés comme suit:
En-tête de premier niveau
=======
En-tête de deuxième niveau
----------
Le rendu aura l’aspect de ceci:
En-tête de premier niveau
En-tête de deuxième niveau
En-tête de troisième niveau
En-tête de quatrième niveau
Vous remarquez que la syntaxe Markdown reste facile à lire et à comprendre même dans sa version texte brut.
Paragraphes et sauts de ligne
Insérez la phrase suivante dans la boîte de texte:
Bienvenue au Programming Historian.
Aujourd'hui, nous allons travailler sur la syntaxe Markdown.
Cette phrase se sépare de la précédente par un saut de ligne.
Cela s’affiche de la manière suivante:
Bienvenue au Programming Historian.
Aujourd’hui, nous allons travailler sur la syntaxe Markdown. Cette phrase se sépare de la précédente par un saut de ligne.
Les paragraphes doivent être séparés par une ligne vide. Tentez de votre côté de laisser une ligne vide entre syntaxe Markdown. et Cette phrase pour comprendre le fonctionnement. Dans certaines implémentations de Markdown, il est possible d’indiquer les simples sauts de ligne en laissant deux espaces vides à la fin de chaque ligne (qui précède). Ceci n’est toutefois pas le cas avec la version GitHub Flavored Markdown que StackEdit utilise par défaut.
Mise en forme
Vous pouvez mettre du texte en italique en le plaçant entre astérisques * ou tirets bas _. De même, pour le mettre en gras, placez le entre deux astérisques ** ou deux tirets bas __.
Essayez de mettre en forme certaines parties du texte selon ces principes:
Je suis **vraiment** ravie des tutoriels du _Programming Historian_.
Ceci s’affiche comme suit:
Je suis vraiment ravie des tutoriels du Programming Historian.
Listes
Markdown permet de créer des listes ordonnées et non ordonnées. Essayez de créer la liste suivante dans la boîte de dialogue:
Liste de courses
----------
* Fruits
* Pommes
* Oranges
* Raisins
* Produits laitiers
* Lait
* Fromage
Indenter l’astérisque * vous permet de créer des objets imbriqués.
Le rendu de ceci est comme suit:
Liste de courses
- Fruits
- Pommes
- Oranges
- Raisins
- Produits laitiers
- Lait
- Fromage
Les listes ordonnées sont rédigées en numérotant chaque ligne. Répétons-le, l’objectif de Markdown est de produire des documents qui sont à la fois lisibles en texte brut et transformables en d’autres formats.
Liste à faire
----------
1. Achever le tutoriel Markdown
2. Aller à l'épicerie
3. Préparer le déjeuner
Cela s’affiche comme suit:
Liste à faire
- Achever le tutoriel Markdown
- Aller à l’épicerie
- Préparer le déjeuner
Blocs de code
Représenter les blocs de code de manière distincte du reste du texte est une bonne pratique qui offre davantage de lisibilité. Habituellement le code est affiché en caractères à chasse fixe. Puisque Markdown ne distingue pas les polices, nous pouvons placer les blocs de code entre des guillements inverses tels `. Par exemple, écrire `<br />`. Nous pouvons insérer des ensembles de code entre trois guillements inverses au début et trois à la fin. Dans la fenêtre de prévisualisation de StackEdit, cela donnera une boîte ombragée avec du texte en chasse fixe.
Insérez le code suivant dans la boîte de dialogue:
```html
<html>
<head>
<title>Titre de site web</title>
</head>
<body>
</body>
</html>
```
Cela donne:
<html>
<head>
<title>Titre de site web</title>
</head>
<body>
</body>
</html>
Remarquez comment le code s’affiche en police à chasse fixe.
Blocs de citation
Ajouter une balise fermante > avant chaque paragraphe le fera apparaître comme élément de citation.
Essayez de taper le texte suivant dans le panel:
> Bonjour, je suis un paragraphe de texte englobé dans un bloc de citation. Regardez comment je suis décalé par rapport à la marge gauche.
Ceci s’affiche comme suit:
Bonjour, je suis un paragraphe de texte englobé dans un bloc de citation. Regardez comment je suis décalé par rapport à la marge gauche.
Liens
Les liens peuvent être signalés selon deux styles.
Pour insérer des liens à l’intérieur du texte, on place d’abord le texte d’accroche entre crochets puis l’URL (et éventuellement du texte supplémentaire) entre parenthèses.
Pour accéder à davantage de tutoriels, merci de visiter la page d'accueil du [Programming Historian](/ "Programming Historian main page").
Ceci s’affiche comme suit:
Pour accéder à davantage de tutoriels, merci de visiter la page d’accueil du Programming Historian.
Les liens de références sont très pratiques pour créer des notes de bas de page et permettent de garder votre document en texte brut propre. Ces liens s’écrivent entre une paire de crochets supplémentaire pour leur créer, essentiellement, un identifiant unique.
Le site web du [Programming Historian][1] fournit un exemple.
Puis vous pouvez ajouter l’URL dans une autre partie du document:
[1]: http://programminghistorian.org/ "The Programming Historian"
Ceci s’affiche comme suit:
Le site web du Programming Historian fournit un exemple.
Images
Les images peuvent être référencées en utilisant un point d’exclamation ! suivi par du texte supplémentaire entre crochets et, entre parenthèses, l’URL de l’image. Le titre de l’image, s’il y en a un, se met entre guillemets. Les images ne s’affichent pas dans votre document en texte brut, mais elles seront intégrées à la page convertie en HTML.
Ceci s’affiche comme cela:
Règles horizontales
Les règles horizontales sont créées lorsqu’au moins trois tirets -, astérisques * ou tirets bas _ s’alignent seuls, avec ou sans espaces entre eux. Toutes les combinaisons suivantes vont donner des règles horizontales:
___
* * *
- - - - - -
Ceci donne cela:
Tables
Les spécifications de la version de base de Markdown ne contiennent pas de règles pour l’encodage de tables. Certaines des variantes de Markdown utilisées par des sites et des applications spécifiques permettent cependant la création de tables et d’autres structures complexes. GitHub Flavored Markdown est une de ces variantes, principalement utilisée pour afficher des fichiers .md dans le navigateur sur le site web de Github.
Il est possible de créer une table dans Github en utilisant des barres verticales | pour séparer les colonnes et des tirets - au milieu de vos en-têtes et du contenu de la table. Les barres verticales sont strictement nécessaires seulement entre les colonnes; vous pouvez néanmoins les utiliser des deux côtés de votre table pour obtenir un résultat plus soigné. Il n’y a pas de limitation quant à la longueur du contenu des cellules et il n’est pas nécessaire d’aligner les barres verticales.
| En-tête 1 | En-tête 2 | En-tête 3 |
| --------------------------- | --------------------------- | --------------------------- |
| Ligne 1, colonne 1 | Ligne 1, colonne 2 | Ligne 1, colonne 3 |
| Ligne 2, colonne 1 | Ligne 2, colonne 2 | Ligne 2, colonne 3 |
| Ligne 3, colonne 1 | Ligne 3, colonne 2 | Ligne 3, colonne 3 |
Cela s’affiche comme suit:
| En-tête 1 | En-tête 2 | En-tête 3 |
|---|---|---|
| Ligne 1, colonne 1 | Ligne 1, colonne 2 | Ligne 1, colonne 3 |
| Ligne 2, colonne 1 | Ligne 2, colonne 2 | Ligne 2, colonne 3 |
| Ligne 3, colonne 1 | Ligne 3, colonne 2 | Ligne 3, colonne 3 |
Pour régler l’alignement de chaque colonne, les deux points : peuvent être ajoutés dans la ligne de l’en-tête comme suit:
| Aligner à gauche | Centrer | Aligner à droite |
| :--------------- | :-----: | ---------------: |
| Pommes | Rouge | 5000 |
| Bananes | Jaune | 75 |
Cela s’affiche comme suit:
| Left-aligned | Centered | Right-aligned |
|---|---|---|
| Pommes | Rouge | 5000 |
| Bananes | Jaune | 75 |
Les limites de Markdown
Même si Markdown devient de plus en plus populaire, notamment pour formatter des documents exposés sur le web, beaucoup de gens et d’éditeurs sollicitent des documents traditionnels en Word, PDF et d’autres formats de fichiers. Certains outils de conversion exécutables en ligne de commande, comme Pandoc, offrent une solution, sans toutefois offrir toutes les fonctionnalités des logiciels de traitement de texte, notamment le versionnage. Pour en savoir plus sur Pandoc, merci de consulter la leçon du Programming Historian intitulée “Sustainable authorship in plain text using Pandoc and Markdown” (en anglais).
Conclusion
Markdown est une solution utile à mi-chemin entre les fichiers textes bruts et les logiciels de traitement de texte aux formats hérités. Sa syntaxe simple est facile à apprendre et lisible non seulement en tant que telle, mais aussi après conversion en HTML et vers d’autres formats. Opter pour écrire ses documents en Markdown c’est s’assurer que ceux-ci seront utilisables et lisibles à long terme.