Découvrir et utiliser le markdown


Accueil > Tutoriels > Découvrir et utiliser le markdown

Par Saint-Martin J. en janvier 2021

Ce tutoriel a été entièrement rédigé par un élève en spécialité NSI au Lycée Louis Pasteur. Pour en savoir plus : Les tutoriels en spécialité NSI

Qu’est-ce que Markdown ?

Tout comme le HTML, conçu pour représenter les pages web, et LaTex, Markdown est un langage de balisage, ayant pour fonction de structurer la mise en page de votre texte, à la différence des langages de programmation, renfermant de nombreuses boucles et variables. Contrairement aux deux autres langages, Markdown est très simple, léger, et facile à comprendre pour les mortels. En effet, réalisé pour les paresseux en ayant assez du formatage sous des logiciels tel Word, ou bien même des balises sous HTML, il permet de rédiger en une syntaxe claire et lisible, sans nécessité d’érudition cyclopéenne. Il sert aussi à convertir directement et sans trop de manipulations un format de texte brut facile à lire et à écrire, en HTML. Il est alors utile pour ceux qui n’ont pas de compétences particulières en informatique, et qui veulent rédiger des documentations, des notes, des textes simples, des messages… sur des forums, notamment sur le fameux Github.
Donc, si vous souhaitez mettre en forme proprement des messages ou des contenus web, ou bien rédiger des documentations, suivez ce tutoriel, et vous assimilerez un nouveau langage en un rien de temps !

Les éditeurs Markdown

Tout d’abord, il vous faut trouver un éditeur à la hauteur de vos attentes et de vos talents, et qui puisse être le plus efficace et convenable selon votre utilisation et vos besoins. Il en existe de nombreux, gratuits ou payants, en ligne ou hors-ligne, open source etc...Mais, lesquels pourront représenter l’élite ?

En ligne

Les meilleurs éditeurs Markdown utilisables gratuitement et directement dans votre navigateur Web, sans besoin d’installation d’applications encombrantes, et prêts à l’emploi rapidement, sont selon moi :

  • StackEdit, comprenant de nombreuses fonctionnalités très utiles.
  • Dilinger, pour une utilisation simple et intuitive.

Hors-ligne

Pour des travaux réguliers et de projets importants, il est préférable d’utiliser des éditeurs hors-ligne, comprenant plus de fonctionnalités, et utilisables sans être connecté à internet. Les plus recommandables, tout en étant gratuits, sont :

  • Typora, fonctionnel sous mac OS, Linux, Windows, permettant une concentration maximale grâce à son design simple, minimaliste et épuré, et à sa fonction de saisie semi-automatique. Il est de loin le plus agréable esthétiquement et à proprement parler à mon avis.
  • Laverna, pour mac OS, Linux ou bien Windows, au concept open source, est très attrayant de par son cryptage paramétrable, et son utilité quant aux envois de fichiers importants.

Il reste tout de même possible d’ouvrir et d’éditer des fichiers markdown avec n’importe quel éditeur de code ou éditeur textuel, mais vous serez alors privés de la coloration syntaxique et de la prévisualisation en temps réel de ce que vous êtes en train d’écrire.
De plus, pour écrire vos mail et les formater convenablement (en HTML techniquement), il est préférable d’utiliser une extension disponible sur Chrome, Firefox et Safari ; Mardown Here (qui fonctionne aussi dans les interfaces d’éditions web Evernote et Wordpress).

La syntaxe de Markdown

Pour pouvoir utiliser ce langage, développé en 2004 par le programmeur américain John Gruber et Aaron Swartz, il vous faut connaître les bases de la syntaxe, et donc ses fonctions principales.
Les balises sont très proches de leurs réelles significations, et donc très intuitives.
Pour les exemples en image, j’utiliserai StackEdit, afin de mettre en exergue les deux parties distinctes, sauf indications contraires.

Les paragraphes

Commençons par le plus élémentaire, les paragraphes, insérables grâce à une ligne vierge (saut de deux lignes, un seul correspondant à un retour chariot).

Les en-têtes

Pour faire des titres de partie, il suffit d’utiliser les caractères hash (#), de 1 à 6 en début de ligne. Ceux-ci correspondent aux niveaux des en-têtes, du 1, le plus grand, au 6.

L’emphase

Pour mettre en relief un mot, ou un texte, il vous suffit d’entourer le mot entre
des étoiles (*), une pour l’italique, qui est une emphase faible, et deux pour le gras, étant une emphase forte. Pour combiner les deux, il vous suffit d’encadrer avec cette fois-ci trois étoiles.
Aussi, pour barrer un texte, il vous faudra entourer le mot avec un double tilde.

Les listes

En markdown, il est possible de faire 3 types de listes ; les listes à puces, numérotées et cochées.
Pour établir une liste simple, il suffit de mettre une étoile (*), un tiret (-) ou un plus (+) devant, les trois étant équivalents.

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

Pour éditer une liste de tâches, mettez des éléments [ ] ou [x], incomplets ou complets. N’oubliez pas de laisser un espace entre les crochets vides, auquel cas votre liste ne sera pas identifiée comme telle (selon l’éditeur, il vous faudra rajouter des tirets devant).

Les citations

Pour générer un texte en citation, vous devrez utiliser le chevron supérieur (>). Pour pouvez soit le faire précéder chaque ligne, soit en insérer un au début du paragraphe et un à la fin. Selon l’éditeur, il n’est pas nécessaire d’en rajouter à la fin, les sauts de ligne suffisent.

Les codes

Pour écrire un bloc de code, soit vous indentez de 4 espaces (ou une tabulation), ou vous mettez votre bloc entre trois apostrophes inversées (```) au début et à la fin.

Sur typora, vous pouvez sélectionner le langage en bas à droite, permettant ainsi d’avoir des couleurs associées aux variables (ce qui est beaucoup plus esthétique).

Si vous voulez écrire un bout de code au milieu d’un paragraphe, entourez le avec une apostrophe inversée.

Les liens

Pour créer un lien, vous devez placer le texte du lien entre crochets suivis de l’URL entre parenthèses.

Les images

Les images s’insèrent de la même manière que des liens, seulement, il faut rajouter un point d’exclamation devant le premier crochet, comme dans l’exemple ci-dessous, édité sur typora.

Il existe encore de nombreux éléments de syntaxe (surligner, tableaux, indice, mathématiques…), si vous voulez plus d’informations et ainsi compléter la documentation, vous pouvez vous rendre directement sur le support de typora.

Conclusion

Le Markdown sert donc à générer du contenu web correctement mis en forme, sans avoir à connaître le HTML. La syntaxe est ainsi d’une simplicité déconcertante, n’étant composée que d’éléments de ponctuation soigneusement choisis afin d’être analogues à ce qu’ils signifient. Ce langage épuré et léger tient son appellation d’un jeu de mot avec markup languages, insistant bien sur le fait que c’est un langage réduit, et un outil complémentaire (html du pauvre).
Voilà, vous pouvez maintenant vous servir du Markdown pour rédiger vos notes proprement, en faire une page web, envoyer des messages ou répondre sur des forums, ou bien même écrire des documentations complètes pour un projet ou un jeu de données.