Rédiger en Markdown : tout ce que vous devez savoir
Présentation
Dans cet article, nous allons présenter la syntaxe de base pour écrire en Markdown, un langage de balisage léger (lightweight markup language) qui offre une syntaxe facile à lire, à écrire et à analyser par d’autres programmes. Le Markdown est souvent utilisé pour la documentation technique et dans les systèmes de gestion de versions comme Git, notamment pour écrire les fichiers README.md qui décrivent le fonctionnement du code source d’un programme. La plupart des éditeurs de texte supportent le Markdown soit nativement ou via une extension.
Syntaxe du Markdown
En-têtes
La première chose à maîtriser lorsque vous écrivez en Markdown sont les en-têtes, que l’on peut considérer comme des titres. Il existe deux manières de créer des en-têtes :
Méthode 1 : Ajoutez un carré / croisillon (hashtag) avant la chaîne caractères qui sera utilisée comme en-tête.
Méthode 2 : Ajoutez un signe égal (=) en dessous de la chaîne caractères qui sera utilisée comme en-tête.
Polices de caractères
Listes
Blocs de citation
Blocs de code
Chaîne caractères surlignée
Tableaux
Table des matières
Insérer des images
Insérer des liens
Caractère d’échappement
Référer à des fichiers avec un lien relatif
Référer à une section d’un autre fichier
Conclusion
Dans ce tutoriel, nous avons passé en revue la syntaxe principale pour écrire en Markdown. Vous êtes maintenant outillés pour écrire des fichiers README.md et faire de la documentation dans vos dépôts Git. Connaître le Markdown est une compétence essentielle aujourd’hui puisqu’il est utilisé dans toutes les plateformes collaboratives comme GitHub ou GitLab, mais aussi sur des sites de documentation. Il permet de respecter la pratique essentielle selon laquelle la documentation doit toujours être avec le code source d’un projet. Le Markdown est très simple, mais, bien sûr, l’apprendre nécessite un peu de pratique. Pour aller plus loin, vous pouvez consulter les sites suivants :
Source : www.it-connect.fr
