Fichier .md : comprendre et utiliser Markdown

Auteur : Publié le

En bref : Un fichier .md est le plus souvent un simple fichier texte rédigé en Markdown, une manière simple de marquer les titres, les listes, les liens et les autres éléments d’un document. Vous pouvez l’ouvrir dans n’importe quel éditeur de texte ; un logiciel prenant en charge Markdown affichera aussi sa version mise en forme. Ce type de fichier sert souvent à rédiger des instructions, des notes, de la documentation et du contenu pour des sites web.

Que signifie l’extension .md ?

L’extension .md, c’est-à-dire la terminaison du nom du fichier, indique généralement un document Markdown. Il s’agit d’un langage de balisage léger : au lieu de choisir la mise en forme dans une barre d’outils, vous saisissez des symboles simples dans le texte. Par exemple, deux astérisques de chaque côté d’un mot le mettent en gras.

Le document reste lisible même sans logiciel particulier. Dans un éditeur de texte, vous verrez les mots et les balises ; dans un aperçu Markdown, vous verrez le contenu mis en forme. La transformation des balises en présentation visuelle du document s’appelle le rendu.

Contrairement à un fichier .docx, un document Markdown ne conserve pas de mise en page élaborée, comme le placement précis des éléments ou les paramètres d’impression. Il se concentre sur le contenu et sa structure. L’extension seule ne garantit toutefois pas le contenu : un fichier peut porter n’importe quel nom. Un document inhabituel portant l’extension .md n’est donc pas nécessairement du texte Markdown valide.

Comment ouvrir un fichier .md et afficher sa mise en forme ?

Pour lire son contenu, un éditeur de texte brut suffit, par exemple le Bloc-notes du système. C’est une bonne solution pour consulter rapidement des instructions ou corriger une seule phrase. Vous verrez alors aussi les symboles qui définissent la mise en forme.

Pour travailler plus confortablement, choisissez un outil doté d’un aperçu Markdown :

Si un double-clic sur le fichier ne lance pas le bon logiciel, utilisez la commande « Ouvrir avec » et choisissez un éditeur de texte. Vous n’avez pas besoin de remplacer l’extension par .txt. Un navigateur web seul n’affichera pas toujours un fichier local .md avec sa mise en forme : il peut montrer le texte brut ou proposer de le télécharger.

À quoi ressemble la syntaxe Markdown en pratique ?

Une courte note suffit pour apprendre les principales notations. L’extrait suivant contient un titre de deuxième niveau, du texte en gras, une liste et du code en ligne :

## Préparation du site

**Avant la publication**, vérifiez :

- l’exactitude des coordonnées,
- le fonctionnement du formulaire,
- l’affichage du site sur un téléphone.

Le fichier de démarrage du projet est `index.html`.

Dans l’aperçu, les signes ## laisseront place à la présentation d’un titre, les astérisques mettront les mots en gras et les tirets créeront une liste à puces. Les accents graves autour de index.html feront ressortir ce nom comme un fragment de code. Une ligne vide sépare les paragraphes ou les blocs de contenu plus importants.

Un lien s’écrit selon le modèle [texte du lien](adresse), et une image selon le modèle ![description de l’image](chemin-du-fichier). L’image n’est généralement pas intégrée au document .md lui-même : cette notation indique son emplacement. Si vous déplacez le document, veillez donc aussi à transférer les fichiers image et à conserver des chemins corrects.

Il existe plusieurs variantes de Markdown, chacune ayant ses règles d’interprétation des balises. Les titres et les listes de base sont largement pris en charge, mais les tableaux, les listes de tâches ou les notes de bas de page peuvent fonctionner différemment selon le logiciel. Si le document est destiné à un système précis, vérifiez son aperçu dans ce système.

Comment créer un fichier .md et le transmettre à quelqu’un ?

Vous pouvez préparer un nouveau document sans installer de logiciel spécialisé :

  1. Ouvrez un éditeur de texte brut et saisissez le contenu avec les balises Markdown.
  2. Choisissez l’enregistrement sous forme de fichier texte, de préférence avec l’encodage UTF-8 pour conserver les caractères polonais.
  3. Donnez-lui un nom, par exemple instructions.md.
  4. Vérifiez que le logiciel n’a pas ajouté automatiquement l’extension .txt, ce qui donnerait instructions.md.txt.
  5. Ouvrez le document dans un aperçu Markdown et vérifiez sa mise en forme.

Renommer un fichier Word de instructions.docx en instructions.md ne convertit pas le document. Il faut exporter le contenu avec un outil adapté, ou le coller sous forme de texte brut puis ajouter les balises.

Si le destinataire doit modifier les instructions, transmettez-lui le fichier .md avec les images utilisées. S’il doit seulement lire le document final, un PDF exporté depuis un logiciel prenant en charge Markdown peut être plus pratique. Les formats d’exportation disponibles dépendent de l’outil choisi.

Quand Markdown est-il un bon choix ?

Markdown convient aux contenus pour lesquels le fond compte davantage que la mise en page : notes, instructions et documentation technique. Le fichier courant README.md décrit généralement un projet, la manière de le lancer ou ses règles d’utilisation. Comme il s’agit de texte brut, il est facile de comparer les versions successives et de repérer les phrases modifiées.

Les fichiers .md peuvent aussi servir de sources pour des articles dans des générateurs de sites tels que Hugo. Un tel système transforme le contenu en page web et lui donne une présentation conforme à un modèle. Le fichier Markdown seul n’est toutefois pas un site prêt à l’emploi.

Pour un document nécessitant une mise en page d’impression précise, des tableaux complexes ou le placement manuel des éléments, un traitement de texte ou un logiciel de mise en page sera plus adapté. Pour commencer, créez une courte note .md et ouvrez-la à la fois sous forme de texte et dans un aperçu : vous verrez immédiatement la différence entre les balises et leur effet.

Voir aussi : Qu’est-ce que la 2FA ?

À lire aussi

Découvrez comment PHP-FPM traite les requêtes PHP, son rôle face au serveur web et comment adapter ses processus au trafic.
Découvrez BIND, logiciel libre de serveur DNS : ses rôles, la gestion des domaines et les cas où le déployer vous-même.
Découvrez le registre polonais REGON, son numéro, ses différences avec NIP et KRS et comment vérifier les données d’une entreprise.