Antisèche Markdown
Markdown est un ensemble de conventions pour écrire du texte formaté dans un fichier brut, et son attrait réside dans le fait que la source reste lisible même quand rien ne la rend. La syntaxe ci-dessous est groupée par ce que vous essayez de faire, et chaque ligne montre l'HTML qu'elle produit réellement.
Ces fragments HTML ne sont pas saisis manuellement. Chacun est la véritable sortie du convertisseur Markdown de ce site, comparée à la table par la suite de tests à chaque compilation — donc si une ligne et l'outil n'étaient jamais d'accord, la compilation échouerait plutôt que la page vous induit en erreur.
Le dialecte est CommonMark plus les extensions GitHub qui sont quasi universelles : tableaux, listes de tâches et barré. Les notes de bas de page, les listes de définitions et les directives sont délibérément absentes, car documenter une syntaxe qui ne fait rien dans le convertisseur à un clic de distance est pire que de l'omettre.
Emphase et code en ligne
9La syntaxe en ligne fonctionne à l'intérieur des paragraphes, titres, éléments de liste et cellules de tableau de manière similaire.
| Syntaxe | Ce qu'il fait | HTML produit |
|---|---|---|
| *italic* | Italique | <p><em>italic</em></p> |
| _italic_ | Italique, forme alternativeIgnoré à l'intérieur d'un mot, donc snake_case survit. | <p><em>italic</em></p> |
| **bold** | Gras | <p><strong>bold</strong></p> |
| __bold__ | Gras, forme alternative | <p><strong>bold</strong></p> |
| ***both*** | Gras et italique ensemble | <p><em><strong>both</strong></em></p> |
| ~~gone~~ | Barré | <p><del>gone</del></p> |
| `code` | Code en ligne — rien à l'intérieur n'est interprété | <p><code>code</code></p> |
| ``a ` b`` | Code en ligne contenant un backtickUtilisez plus de backticks dehors que n'apparaissez dedans. | <p><code>a ` b</code></p> |
| \*not italic\* | Un astérisque littéral au lieu d'une emphase | <p>*not italic*</p> |
Titres
7La forme de hachage est celle à utiliser ; la forme souligné n'atteint que deux niveaux.
| Syntaxe | Ce qu'il fait | HTML produit |
|---|---|---|
| # Heading | Titre de niveau 1 | <h1>Heading</h1> |
| ## Heading | Titre de niveau 2 | <h2>Heading</h2> |
| ### Heading | Titre de niveau 3 | <h3>Heading</h3> |
| ###### Heading | Titre de niveau 6 — le plus profond qu'il y ait | <h6>Heading</h6> |
| Heading ======= | Titre de niveau 1, forme soulignée | <h1>Heading</h1> |
| Heading ------- | Titre de niveau 2, forme soulignée | <h2>Heading</h2> |
| ## Heading ## | Les hachures finales sont des ornements et sont suppriméesLe nombre à droite est ignoré ; seul celui de gauche définit le niveau. | <h2>Heading</h2> |
Listes
7Indentez par deux espaces à imbriquement. Une ligne vierge entre les éléments rend chacun un paragraphe.
| Syntaxe | Ce qu'il fait | HTML produit |
|---|---|---|
| - one - two | Liste à puces | <ul> <li>one</li> <li>two</li> </ul> |
| * one * two | Liste à puces, marqueur alternatif | <ul> <li>one</li> <li>two</li> </ul> |
| 1. one 2. two | Liste numérotée | <ol> <li>one</li> <li>two</li> </ol> |
| 1. one 1. two | Aussi une liste numérotée, renumérotée au renduSeul le premier numéro est utilisé ; le reste peut tous être 1. | <ol> <li>one</li> <li>two</li> </ol> |
| - one - nested | Liste imbriquée — indentez l'enfant de deux espaces | <ul> <li>one <ul> <li>nested</li> </ul></li> </ul> |
| - [ ] todo | Élément de liste de tâches décochée | <ul> <li><input type="checkbox" disabled /> todo</li> </ul> |
| - [x] done | Élément de liste de tâches coché | <ul> <li><input type="checkbox" checked disabled /> done</li> </ul> |
Liens et images
6| Syntaxe | Ce qu'il fait | HTML produit |
|---|---|---|
| [text](https://a.co) | Lien | <p><a href="https://a.co">text</a></p> |
| [text](https://a.co "Tip") | Lien avec un titre de conseil | <p><a href="https://a.co" title="Tip">text</a></p> |
| <https://a.co> | URL nue transformée en lien | <p><a href="https://a.co">https://a.co</a></p> |
| [mail](mailto:a@b.co) | Lien de courrier électronique | <p><a href="mailto:a@b.co">mail</a></p> |
|  | Image, avec texte alternatif | <p><img src="cat.png" alt="alt" /></p> |
| [x](javascript:alert(1)) | Schéma non sûr — le lien est supprimé, le texte restejavascript:, data: et vbscript: les URL perdent leur href. | <p>x</p> |
Éléments de bloc
9Chacun de ceux-ci doit commencer au début d'une ligne.
| Syntaxe | Ce qu'il fait | HTML produit |
|---|---|---|
| > quoted | Bloc de citation | <blockquote> <p>quoted</p> </blockquote> |
| > > deeper | Bloc de citation imbriqué | <blockquote> <blockquote> <p>deeper</p> </blockquote> </blockquote> |
| ``` code ``` | Bloc de code clôturé | <pre><code>code </code></pre> |
| ```js let a = 1; ``` | Bloc de code clôturé avec une classe de langue pour la surlignance | <pre><code class="language-js">let a = 1; </code></pre> |
| code | Bloc de code par indentation à quatre espaces | <pre><code>code </code></pre> |
| --- | Règle horizontale | <hr /> |
| *** | Règle horizontale, forme alternative | <hr /> |
| one two | Saut de ligne à l'intérieur d'un paragrapheDeux espaces finaux. Invisible dans la plupart des éditeurs, c'est pourquoi il échoue si souvent. | <p>one<br /> two</p> |
| one two | Une ligne vierge sépare les paragraphes | <p>one</p> <p>two</p> |
Tableaux
4La ligne de délimiteur est ce qui en fait un tableau. L'alignement est défini par les deux-points dans cette ligne.
| Syntaxe | Ce qu'il fait | HTML produit |
|---|---|---|
| | a | b | | - | - | | 1 | 2 | | Tableau — en-tête, ligne de délimiteur, puis lignes de corps | |
| | :--- | | Alignez la colonne à gauche, dans la ligne de délimiteur | |
| | :---: | | Centrer la colonne | |
| | ---: | | Alignez la colonne à droite |