Retour au blog

L'aide-mémoire de démarque la plus complète en ligne

L'aide-mémoire de démarque la plus complète en ligne. Chaque élément de syntaxe avec des exemples, le rendu, la compatibilité de la plate-forme, les erreurs courantes et les conseils d'experts. Ajoutez-le à vos favoris.

Benjamin McBrayer // Publié: 21 avril 202619 min de lecture

Markdown est un moyen simple de formater du texte à l'aide de symboles tels que des hashtags, des astérisques et des crochets. Il est utile pour les écrivains, les blogueurs, les développeurs, les étudiants et tous ceux qui créent du contenu en ligne, car il rend le formatage rapide, propre et facile à réutiliser sur différentes plates-formes. Cette aide-mémoire Markdown vous montrera les règles les plus courantes afin que vous puissiez désormais écrire et publier dans Markdown.

Qu'est-ce que la démarque ?

Markdown est un langage de balisage léger qui vous permet d'utiliser des symboles en texte brut pour formater des documents. Lorsque vous tapez **bold**, vous devenez gras. Lorsque vous tapez « # Titre », cela devient un titre. Lorsque vous utilisez Markdown, il est converti en HTML. Il fonctionne sur pratiquement toutes les plateformes et est devenu le langage par défaut pour le formatage sur des milliers d'outils, de plateformes et de sites Web, notamment GitHub, Reddit, Discord, Notion, Slack et Obsidian.


Pourquoi la démarque est importante

John Gruber a créé Markdown en 2004 dans le but de permettre aux utilisateurs d'écrire et de formater des documents en utilisant du texte brut sans avoir à regarder un fouillis de balises. Aujourd'hui, Markdown est devenu un langage utilisé par pratiquement tous les développeurs et constructeurs, ainsi que par les rédacteurs de contenu et autres.

Les avantages du Markdown

Markdown est si populaire car il résout de nombreux problèmes qui posaient problème avec les formats antérieurs.

  • Markdown fonctionne partout et le fera toujours : Vous pouvez ouvrir un fichier .md dans n'importe quel éditeur de texte et sur n'importe quel système d'exploitation, et vous pourrez l'ouvrir dans 50 ans.
  • Vous pouvez lire Markdown sans le rendre : Contrairement au RTF ou au HTML, Markdown est un format lisible dans sa forme brute, pas seulement après son rendu.
  • Markdown est rapide à utiliser : Les rédacteurs expérimentés peuvent formater le texte au fur et à mesure qu'ils le tapent et travailler plus rapidement.
  • Markdown est universel : Comme mentionné précédemment, de nombreuses plates-formes utilisent Markdown de manière native.

De nos jours, Markdown est important à connaître pour quiconque crée quelque chose avec des outils d'IA, car les LLM génèrent Markdown par défaut.


Syntaxe de démarque de base

Ces éléments proviennent de la spécification originale de John Gruber de 2004. Chaque analyseur de démarques les prend en charge, avec des différences d'implémentation mineures indiquées ci-dessous.

Tableau de référence rapide

Élément Syntaxe de démarque
Rubrique démarque #H1 ## H2 ### H3
Démarquage gras **gras** ou __bold__
Démarquage italique *italique* ou _italic_
Markdown Gras + Italique ***gras italique***
Citation de bloc de démarque > texte cité
Liste commandée par démarque 1. Article
Liste non ordonnée Markdown - Article ou * Article ou + Article
Code en ligne Markdown `code`
Bloc de code de démarque Indentez 4 espaces ou utilisez des blocs clôturés
Règle horizontale de démarque --- ou *** ou ___
Lien de démarque [texte](https://exemple.com)
Image de démarque ![texte alternatif](image.jpg)
Saut de ligne de démarque Terminer une ligne avec deux espaces de fin
Personnage d’évasion Markdown \*astérisque littéral\*

Titres de démarque

Utilisez 1 à 6 signes dièse (#) suivis d'un espace. Le nombre de signes correspond au niveau du titre HTML.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Syntaxe alternative (style Setext) fonctionne uniquement pour H1 et H2 :

Heading 1
=========

Heading 2
---------

Bonnes pratiques :

  • Mettez toujours un espace entre # et le texte du titre. #Heading fonctionne dans certains analyseurs mais s'interrompt dans d'autres.
  • Utilisez un seul H1 par document (généralement le titre de la page).
  • Ne sautez pas les niveaux de titre. Allez H1 → H2 → H3, pas H1 → H3.
  • Ajoutez des lignes vides avant et après les titres pour une compatibilité maximale.

Markdown gras, italique et accentué

**This is bold** and __this is also bold__
*This is italic* and _this is also italic_
***Bold and italic*** combined

Rend comme :

C'est en gras et c'est aussi en gras C'est en italique et c'est aussi en italique Gras et italique combinés

Je vous ai eu : Certains analyseurs ne gèrent pas les traits de soulignement au milieu d'un mot. Pour une compatibilité maximale, utilisez des astérisques pour mettre l'accent au milieu du mot : un**believ**able, et non un__believ__able.

Citations de démarques

Commencez n'importe quelle ligne avec > pour créer un blockquote markdown.

> This is a single-line blockquote.

> This is a blockquote
> that spans multiple lines.

> Blockquotes can be nested.
>
> > Like this.
>
> And they can contain **other markdown** elements.

Les blockquotes Markdown fonctionnent bien pour mettre l’accent sur les citations, les légendes et le formatage de style réponse dans les e-mails.

Listes de démarques

Les listes non ordonnées acceptent -, * ou + de manière interchangeable. Choisissez un style et respectez-le pour plus de cohérence.

- First item
- Second item
- Third item
  - Nested item (indent two or four spaces)
  - Another nested item
- Fourth item

Les listes ordonnées utilisent des chiffres suivis d'un point :

1. First item
2. Second item
3. Third item

Astuce utile : Il n'est pas nécessaire que les chiffres soient corrects. Markdown renumérote automatiquement :

1. First
1. Second
1. Third

… s'affiche de manière identique à « 1, 2, 3 ». Cela signifie que vous pouvez réorganiser les articles sans les renuméroter.

Imbrication de listes de démarques ordonnées et non ordonnées :

1. First step
2. Second step
   - Sub-bullet
   - Another sub-bullet
3. Third step
   1. Sub-step
   2. Another sub-step

Liste des éléments comportant plusieurs paragraphes : Indentez la suite du même nombre d'espaces (généralement 4 ou une tabulation) :

1. First item

    This paragraph belongs to the first item.
    Notice the blank line above and the indent.

2. Second item

Liens de démarque

Les liens en ligne sont le style le plus courant :

[Visit Google](https://www.google.com)
[With hover title](https://www.google.com "Google's homepage")

Les liens de démarque de style référence sont utiles lorsque la même URL apparaît plusieurs fois ou lorsque vous souhaitez conserver une prose claire :

I love [Obsidian][1] and [VS Code][vscode] for markdown.

[1]: https://obsidian.md
[vscode]: https://code.visualstudio.com

URL automatiques. Placez une URL nue entre crochets :

<https://example.com>
<hello@example.com>

Liens relatifs. Lien vers des fichiers dans le même référentiel ou dossier :

[Read the license](./LICENSE.md)
[Parent directory file](../README.md)

Liens d'ancrage Markdown. Accédez à un en-tête sur la même page. La plupart des analyseurs génèrent automatiquement des identifiants à partir du texte du titre (minuscules, espaces jusqu'aux tirets) :

Jump to [the installation section](#installation).

## Installation

Images de démarque

La syntaxe de l'image Markdown est la syntaxe du lien avec un point d'exclamation en tête :

![Descriptive alt text](/path/to/image.jpg)
![Alt text](/path/to/image.jpg "Optional hover title")

Les images démarques de style référence fonctionnent de la même manière que les liens de référence :

![Company logo][logo]

[logo]: /images/logo.png "Our logo"

Faire d'une image démarque un lien :

[![Alt text](image.jpg)](https://example.com)

** Dimensionnement des images. ** Le markdown pur n'a pas de syntaxe pour cela. Utilisez le HTML en ligne comme solution de secours :

<img src="image.jpg" alt="Alt text" width="400">

Remarque sur l'accessibilité : Écrivez toujours un texte alternatif significatif. Les lecteurs d’écran en dépendent et les moteurs de recherche l’utilisent pour comprendre le contenu des images. ![](logo.png) est mauvais ; ![Logo de l'entreprise, cercle bleu avec un M blanc](logo.png) c'est bien.

Code de démarque

Le code en ligne Markdown est enveloppé dans des backticks simples :

Install with `npm install markdown-it`.

Blocs de code Markdown. Indentez chaque ligne de quatre espaces (ou d'une tabulation) :

    function hello() {
      console.log("Hello, world!");
    }

En pratique, presque tout le monde utilise à la place des blocs de code isolés (couverts dans la section de syntaxe étendue ci-dessous) car ils prennent en charge la coloration syntaxique.

Échapper aux backticks à l'intérieur du code en ligne. Utilisez plus de backticks à l'extérieur :

To show a backtick, use `` `backtick` `` like this.

Règles horizontales de démarque

Au moins trois traits d'union, astérisques ou traits de soulignement sur leur propre ligne :

---
***
___

Tous les trois s'affichent de manière identique. Mettez des lignes vides avant et après pour des raisons de compatibilité.

Sauts de ligne de démarque

C'est l'une des fonctionnalités les plus déroutantes de Markdown. Il existe trois comportements différents :

Saut de paragraphe. Laissez une ligne vide entre le texte :

This is paragraph one.

This is paragraph two.

Saut de ligne ferme (même paragraphe). Terminez une ligne avec deux espaces de fin :

This line ends with two spaces.␣␣
This line is a break within the same paragraph.

Résolution HTML. Utilisez <br> lorsque les espaces de fin semblent trop fragiles :

This line has an HTML break.<br>
This is the next line.

Pourquoi les espaces de fin sont controversés : Ils sont invisibles. La plupart des éditeurs les suppriment lors de la sauvegarde. GitHub Flavored Markdown (GFM) résout ce problème en traitant n'importe quelle nouvelle ligne comme un saut de ligne dans un paragraphe, mais le CommonMark standard nécessite les espaces de fin.

Caractères d'échappement Markdown

Pour afficher un caractère que Markdown interpréterait normalement comme un formatage, faites-le précéder d'une barre oblique inverse :

\*This shows literal asterisks\*
\# This shows a literal hash sign
\[not a link\]

Caractères escamotables : \ ` * _ {} [] () # + - . ! |


Syntaxe de démarque étendue

Ces éléments ne figurent pas dans la spécification originale de Gruber, mais les processeurs de démarques les plus utilisés les prennent en charge, notamment GitHub, GitLab, Reddit, Stack Overflow, Obsidian, Notion et Discord. La compatibilité varie, alors vérifiez la matrice ci-dessous avant de vous fier à l'un d'entre eux.

Tableau de référence rapide

Élément Syntaxe de démarque
Tableau de démarque | En-tête | En-tête | + | --- | --- |
Bloc de code clôturé Markdown ```langue ...```
Point culminant de la syntaxe Markdown Nom de la langue après l'ouverture de la clôture
Note de bas de page Voici une note.[^1] ... [^1] : Texte de la note.
ID de titre de démarque ### Mon titre {#custom-id}
Liste de définitions de démarques term newline : définition
Markdown barré ~~texte supprimé~~
Liste des tâches de démarque - [x] Terminé - [ ] À faire
Code court Emoji Markdown :joy: :fusée:
Points forts de la démarque ==mis en surbrillance==
Indice de démarque H~2~O
Exposant de démarque E = mc^2^
URL automatique de démarque <https://exemple.com>
Alertes de démarque GitHub > [!NOTE] > [!WARNING] > [!TIP]

Tableaux de démarques

Utilisez des barres verticales (|) pour les colonnes et une rangée de traits d'union pour le séparateur d'en-tête.

| Name     | Role       | Location      |
| -------- | ---------- | ------------- |
| Alice    | Developer  | Berlin        |
| Bob      | Designer   | Montreal      |
| Carol    | Writer     | Sydney        |

Alignement des colonnes. Ajoutez des deux-points à la ligne de séparation :

| Left-aligned | Centered     | Right-aligned |
| :----------- | :----------: | ------------: |
| apples       | bananas      |          $100 |
| cherries     | dates        |           $12 |

Conseils qui manquent à la plupart des guides :

  • Vous n'avez pas besoin d'aligner les tuyaux dans votre source. Le moteur de rendu gère l'espacement.
  • Les tuyaux externes sont facultatifs, mais leur ajout contribue à la lisibilité et aux plugins de l'éditeur.
  • Vous pouvez utiliser du démarque de base à l'intérieur des cellules (**bold**, *italic*, `code`, liens).
  • Vous ne pouvez pas utiliser d'éléments de bloc (titres, citations, listes) à l'intérieur des cellules.
  • Pour le contenu multiligne à l'intérieur d'une cellule, utilisez <br> au lieu d'un saut de ligne.
  • Pour afficher un caractère pipe littéral à l'intérieur d'une cellule, utilisez l'entité HTML |.

Blocs de code clôturés Markdown

Trois backticks (ou tildes) ouvrent et ferment un bloc. Ajoutez un identifiant de langue après la clôture d'ouverture pour la coloration syntaxique :

```Python
def saluer (nom):
    return f"Bonjour, {nom} !"

print(salutation("monde"))```

Identificateurs de langage courants : python, javascript, typescript, bash, shell, sql, json, yaml, html, css, rust, go, java, c, cpp, csharp, php, ruby, swift, kotlin, dart, r, scala, diff.

Affichage des modifications de code avec diff :

```différence
- const old = "supprimer ceci" ;
+ const new = "ajouter ceci" ;```

Échapper aux triples backticks. Enveloppez le bloc en quatre backticks :

````
Ce bloc contient```triple backticks```à l'intérieur.````

Notes de bas de page de démarque

Les notes de bas de page Markdown sont parfaites pour les citations, les apartés et les notes explicatives sans encombrer votre prose.

Here is a statement that needs a source.[^1]

Here is another claim.[^detailed-note]

[^1]: This is a short footnote.
[^detailed-note]: Named footnotes still render as numbers, but they're
    easier to track in the source. They can span multiple lines if you
    indent the continuation.

ID de titre Markdown

Certains analyseurs vous permettent d'attribuer des identifiants personnalisés aux titres pour un lien d'ancrage précis :

### My Great Heading {#custom-heading-id}

Jump to [my heading](#custom-heading-id).

GitHub et bien d'autres génèrent automatiquement des identifiants à partir du texte d'en-tête, vous n'en avez donc généralement pas besoin.

Listes de définitions de démarque

Markdown
: A lightweight markup language for formatting plain text.

HTML
: The standard markup language for web pages.

CSS
: The language used to style HTML documents.

Le support est inégal. Cela fonctionne dans Pandoc, PHP Markdown Extra et quelques autres, mais pas dans GFM standard.

Markdown barré

Enveloppez le texte dans deux tildes pour le rayer :

~~This text is struck through.~~

Rend comme : Ce texte est barré.

Fonctionne avec GFM, Reddit, Discord, Slack et les processeurs les plus largement utilisés. Pas dans la norme CommonMark.

Listes de tâches de démarque

Cases à cocher interactives, couramment utilisées dans les problèmes GitHub, les demandes d'extraction et les tableaux de projets :

- [x] Write the first draft
- [x] Edit for clarity
- [ ] Publish the article
- [ ] Promote on social media
  - [ ] Twitter
  - [ ] LinkedIn
  - [ ] Hacker News

Sur GitHub, ceux-ci s'affichent sous forme de cases à cocher cliquables que vous pouvez activer directement dans l'interface utilisateur.

Emoji de démarque

La plupart des plateformes prennent en charge les shortcodes emoji :

Ship it :rocket: and celebrate :tada::champagne:

Vous pouvez également coller directement de vrais caractères emoji. Ils s'affichent correctement dans n'importe quel fichier markdown puisqu'ils sont simplement Unicode. 🚀🎉

Markdown Highlight, Indice, Exposant

I need to ==highlight== this important idea.
Water is H~2~O.
Einstein's famous equation: E = mc^2^.

Le support est limité. Fonctionne dans Obsidian, MultiMarkdown et certains analyseurs étendus, mais pas GFM.

Lien automatique d'URL Markdown

Enveloppez une URL entre crochets pour créer un lien automatique :

<https://example.com>
<contact@example.com>

Dans GitHub Flavored Markdown, toute URL nue est automatiquement convertie. Vous n'avez même pas besoin des supports.


Matrice de compatibilité des plateformes

Utilisez ce tableau pour vérifier quels éléments de syntaxe fonctionnent sur les plateformes que vous utilisez. « Oui » signifie une prise en charge complète, « Non » signifie aucune prise en charge et « Partielle » signifie que la fonctionnalité fonctionne avec des limitations ou utilise une syntaxe non standard.

Fonctionnalité GFM GitLab Reddit Discorde Mou Notion Obsidienne Débordement de pile
Rubriques Oui Oui Oui Non Non Oui Oui Oui
Gras / Italique Oui Oui Oui Oui Partiel* Oui Oui Oui
Barré Oui Oui Oui Oui Oui Oui Oui Oui
Citation de bloc Oui Oui Oui Oui Oui Oui Oui Oui
Listes Oui Oui Oui Oui Oui Oui Oui Oui
Code en ligne Oui Oui Oui Oui Oui Oui Oui Oui
Code clôturé Oui Oui Oui Oui Oui Oui Oui Oui
Point culminant de la syntaxe Oui Oui Partielle Partielle Non Oui Oui Oui
Liens Oui Oui Oui Oui Partiel** Oui Oui Oui
Images Oui Oui Partielle Partielle Partielle Oui Oui Oui
Tableaux Oui Oui Oui Non Non Oui Oui Oui
Listes de tâches Oui Oui Non Non Non Oui Oui Non
Notes de bas de page Oui Oui Non Non Non Non Oui Non
Codes courts Emoji Oui Oui Non Oui Oui Non Partielle Non
Mathématiques (LaTeX) Oui Oui Non Non Non Oui Oui Oui
Diagrammes de sirène Oui Oui Non Non Non Non Oui Non
Souligner Non Non Non Oui Non Oui Partielle Non
Texte du spoiler Non Non Oui Oui Non Non Non Non

* Slack utilise des astérisques simples pour le gras (et non des doubles) et des traits de soulignement simples pour l'italique. ** Slack utilise la syntaxe <url|text> au lieu des liens de démarque standard.


Markdown aromatisé à GitHub

GitHub Flavored Markdown (GFM) est le dialecte de démarque le plus influent. GitHub étant le site par défaut pour les projets open source, les conventions GFM sont devenues le standard de facto.

GFM ajoute ce qui suit en plus de la démarque standard :

Alertes GitHub

Une syntaxe spéciale de guillemets pour les légendes. Cinq types sont pris en charge :

> [!NOTE]
> Useful information that users should know.

> [!TIP]
> Helpful advice for doing things better.

> [!IMPORTANT]
> Key information users need to know.

> [!WARNING]
> Urgent info needing immediate attention.

> [!CAUTION]
> Advises about risks or negative outcomes.

Chacun s'affiche avec une couleur et une icône distinctes sur GitHub.

Références Markdown liées automatiquement

Dans les dépôts GitHub, certains modèles deviennent automatiquement des liens :

  • #123 → liens vers l'émission ou la pull request #123
  • @username → mentionne un utilisateur
  • org/repo#123 → liens vers un problème dans un autre dépôt
  • a1b2c3d → liens vers un hachage de validation

Diagrammes de sirène Markdown

Blocs de code clôturés avec « sirène » comme langage rendu sous forme d'organigrammes, de diagrammes de séquence, et plus encore :

```sirène
graphique LR
    A[Début] --> B{Décision}
    B -->|Oui| C[Faire la chose]
    B -->|Non| D[Passer ça]```

Expressions mathématiques Markdown

GFM prend en charge les mathématiques LaTeX sous deux formes :

Inline math: $E = mc^2$

Block math:

$$
\frac{n!}{k!(n-k)!} = \binom{n}{k}
$$

Markdown spécifique à la plate-forme

Discorde démarque

Discord utilise sa propre variante de démarque. Principales différences par rapport à la norme :

  • __underline__ (double soulignement) produit un soulignement, pas du gras
  • **gras** fonctionne toujours
  • *italic* et _italic_ fonctionnent tous les deux
  • ||spoiler|| masque le texte jusqu'à ce qu'on clique dessus
  • # Heading fonctionne, mais seuls H1, H2 et H3 sont pris en charge
  • Les blocs de code et le code en ligne fonctionnent normalement
  • Pas de tableaux, pas d'images via la syntaxe markdown

Slack Markdown (mrkdwn)

La saveur de démarque de Slack, appelée à confusion « mrkdwn », diverge considérablement :

  • *bold* utilise des astérisques simples (pas doubles)
  • _italic_ utilise des traits de soulignement uniques
  • ~strikethrough~ utilise des tildes uniques
  • `code` fonctionne normalement
  • > quote fonctionne normalement
  • Les liens utilisent la syntaxe <https://example.com|link text>
  • Pas de titres, pas de tableaux, pas de listes de tâches

Si vous collez une démarque standard dans Slack, elle ne sera pas formatée correctement. Convertissez d'abord.

Reddit Markdown

Reddit prend en charge la plupart des syntaxes standard et étendues avec quelques bizarreries :

  • >!spoiler!< pour le texte du spoiler
  • ^exposant avec un caret (aucun signe de fermeture n'est nécessaire pour les mots simples)
  • Prend en charge les tableaux, les barrés et les blocs de code
  • Ne prend pas en charge les listes de tâches, les notes de bas de page ou les identifiants de titre personnalisés

Notion Markdown

Notion prend en charge la saisie markdown mais la convertit en son système de blocs. Vous pouvez taper markdown pour créer des blocs rapidement :

  • La démarque standard fonctionne pendant la saisie
  • Notion ajoute ses propres fonctionnalités (bases de données, bascules, légendes) qui ne sont pas des démarques standard
  • Coller le contenu markdown importe généralement proprement

Réduction d'obsidienne

Obsidian est une application de prise de notes qui utilise le markdown, avec plusieurs extensions :

  • [[Liens de style Wiki]] pour les liens internes entre les notes
  • [[Note#heading]] pour créer un lien vers un titre spécifique dans une autre note
  • ![[Note]] pour intégrer le contenu d'une autre note
  • > [!note] Titre de la légende pour les légendes Obsidian (similaire aux alertes GitHub)
  • Prise en charge complète des mathématiques LaTeX
  • Prise en charge complète de la sirène

Erreurs courantes de démarque

Même les écrivains expérimentés commettent ces erreurs de démarque. Voici ce qu'il faut éviter et comment.

1. Lignes vides manquantes autour des éléments du bloc de démarque

Les listes, les titres, les blocs de code et les guillemets nécessitent généralement une ligne vide avant et après. Sans cela, certains analyseurs les fusionnent dans le paragraphe environnant.

Faux:```markdown Here is a paragraph.

Heading

More text.


**Droite:**```markdown
Here is a paragraph.

## Heading

More text.

2. Indentation incohérente de la liste de démarques

Les listes imbriquées nécessitent une indentation cohérente. Mélanger des retraits à deux et quatre espaces, ou mélanger des tabulations et des espaces, produit des résultats imprévisibles. Choisissez-en un et respectez-le.

3. Oublier les espaces de fin pour les sauts de ligne de démarque

Si vous souhaitez un saut de ligne dans un paragraphe mais que votre texte se déroule ensemble, vous avez probablement oublié les deux espaces de fin. Il s'agit de la question de démarque la plus courante sur Stack Overflow.

4. Les chemins relatifs des images de démarque se rompent après le déploiement

![logo](images/logo.png) fonctionne dans votre éditeur mais s'arrête lorsqu'il est déployé dans un sous-répertoire. Utilisez des chemins absolus du site (/images/logo.png) ou des URL complètes pour la portabilité.

5. Utilisation de guillemets intelligents de style Word dans les blocs de code markdown

Lorsque vous collez du code à partir d'un document comportant des guillemets bouclés (""au lieu de"`), le code ne fonctionnera pas une fois copié. Collez toujours le code sous forme de texte brut dans les fichiers markdown.

6. Mélanger HTML et markdown dans le même bloc

Le Markdown à l’intérieur des balises HTML au niveau du bloc ne s’affiche souvent pas. Cela échoue :

<div>
**This bold won't render.**
</div>

Corrigez-le en les séparant par des lignes vides ou en utilisant uniquement du HTML en ligne :

<div>

**This bold will render.**

</div>

7. Sauter les niveaux de titre de démarque

Passer directement du H1 au H3 abaisse le niveau d’accessibilité et nuit au référencement. Utilisez les niveaux de titre de manière séquentielle.

8. Utiliser des traits de soulignement dans les mots dans le markdown

un_believ_able produit des italiques dans certains analyseurs et des traits de soulignement littéraux dans d'autres. Utilisez des astérisques pour mettre l'accent au milieu du mot : « unbelievable ».


Questions fréquemment posées sur le Markdown

A quoi sert la démarque ?

Markdown est utilisé pour la documentation (README, documents API, wikis), les articles de blog, la rédaction technique, la prise de notes, les messages de discussion sur des plateformes comme Discord et Slack, les sites Web statiques, les livres électroniques et partout où le formatage de texte brut est utile. La plupart des grands modèles de langage génèrent des réponses en markdown par défaut.

La démarque est-elle la même sur toutes les plateformes ?

La syntaxe de base (titres, emphase, listes, liens, code, guillemets) fonctionne presque partout, mais les fonctionnalités étendues telles que les tableaux, les notes de bas de page, les listes de tâches et les mathématiques varient considérablement d'une plate-forme à l'autre. Voir la matrice de compatibilité ci-dessus pour plus d'informations.

Quelle extension de fichier le markdown utilise-t-il ?

.md est le plus courant. Vous pouvez également voir « .markdown », « .mdown », « .mkd » ou « .mkdn ». Ils sont tous du même format. Le type MIME est « text/markdown », enregistré dans la RFC 7763.

Puis-je utiliser du HTML dans le markdown ?

Oui. Presque tous les processeurs de démarques transmettent le HTML brut à la sortie. C'est ainsi que les gens ajoutent des fonctionnalités que Markdown ne prend pas en charge de manière native, telles que les balises <kbd> pour les touches du clavier, <details> pour les sections pliables, <iframe> pour les intégrations, et plus encore.

Comment convertir les démarques en PDF, Word ou HTML ?

Vers HTML : Chaque processeur de démarque le fait de manière native. Pandoc, Markdown-it et Marked sont des bibliothèques populaires.

Vers PDF : Utilisez Pandoc (pandoc input.md -o output.pdf), la fonction d'exportation de Typora ou VS Code avec l'extension PDF Markdown.

Vers Word (.docx) : Pandoc gère cela proprement avec pandoc input.md -o output.docx.

Markdown prend-il en charge les équations mathématiques ?

Pas dans la spécification d'origine, mais de nombreux processeurs (GitHub, GitLab, Obsidian, MkDocs, Jupyter, Notion) prennent en charge les mathématiques LaTeX. Utilisez $...$ pour les mathématiques en ligne et $$...$$ pour les équations en bloc.

En quoi le markdown est-il différent du HTML ?

HTML utilise des balises (<p>, <strong>, <a>) qui sont verbeuses mais précises. Markdown utilise des symboles de ponctuation qui sont rapides à saisir et restent lisibles sous forme de texte brut. Chaque fichier markdown est finalement converti en HTML pour être affiché. Markdown est un sur-ensemble de HTML. Vous pouvez toujours déposer du HTML dans un fichier markdown lorsque vous avez besoin de quelque chose que le markdown ne peut pas exprimer.

Qu'est-ce que CommonMark ?

CommonMark est une spécification standardisée pour le markdown, publiée en 2014 pour résoudre les ambiguïtés de la spécification originale de Gruber. La plupart des processeurs implémentent CommonMark comme base, puis ajoutent des extensions (tableaux, listes de tâches, etc.) par-dessus. GitHub Flavored Markdown est CommonMark plus les extensions de GitHub.

La démarque est-elle gratuite ?

Oui. Markdown n'est pas un logiciel. C'est une spécification. La spécification Gruber originale et la spécification CommonMark sont disponibles gratuitement. Le nom « Markdown » lui-même n'est pas une marque déposée.

Combien de temps faut-il pour apprendre le démarque ?

Les bases (titres, gras, italique, liens, listes) prennent environ cinq minutes. Vous pouvez rédiger une démarque utile en une heure. La maîtrise de la syntaxe étendue et des variations spécifiques à la plate-forme prend plus de temps, mais cette aide-mémoire couvre presque tout ce dont vous aurez besoin.

Quelle est la différence entre le markdown et le texte enrichi ?

Les formats de texte enrichi (.docx, .rtf) stockent le formatage sous forme de données binaires ou XML à côté du texte. Markdown stocke le formatage sous forme de symboles visibles en texte brut. Le compromis : le texte enrichi vous offre un contrôle parfait au pixel près au détriment de la portabilité ; markdown vous offre portabilité et rapidité au détriment d’un contrôle précis.