ANNONCE
Bienvenue sur mon blog ! Ceci est un exemple d'annonce.
En savoir plus

Tutoriel Markdown

Résumer cet article avec :
1931 mots
10 minutes
Tutoriel Markdown

Ceci est un exemple illustrant comment écrire un fichier Markdown. Ce document rassemble la syntaxe de base et les extensions courantes (GFM).

Éléments de bloc

Paragraphes et sauts de ligne

Paragraphe

Balise HTML : <p>

Séparez les paragraphes par une ou plusieurs lignes vides. (Une ligne ne contenant que des espaces ou des tabulations est également considérée comme vide.)

Code :

This will be
inline.
This is second paragraph.

Aperçu :


This will be inline.

This is second paragraph.


Saut de ligne

Balise HTML : <br />

Ajoutez deux espaces ou plus en fin de ligne pour produire un saut de ligne.

Code :

This will be not
inline.

Aperçu :


This will be not
inline.


Titres

Markdown supporte deux styles de titres : Setext et atx.

Setext

Balises HTML : <h1>, <h2>

Utilisez des signes égal (=) pour <h1> et des tirets (-) pour <h2>, en nombre quelconque, en guise de « soulignement ».

Code :

This is an H1
=============
This is an H2
-------------

Aperçu :


This is an H1

This is an H2


atx

Balises HTML : <h1>, <h2>, <h3>, <h4>, <h5>, <h6>

Placez 1 à 6 dièses (#) en début de ligne pour correspondre respectivement à <h1> jusqu’à <h6>.

Code :

# This is an H1
## This is an H2
###### This is an H6

Aperçu :


This is an H1

This is an H2

This is an H6

Optionnel : vous pouvez « fermer » un titre atx en fin de ligne. Le nombre de dièses de fermeture n’a pas besoin de correspondre à celui d’ouverture.

Code :

# This is an H1 #
## This is an H2 ##
### This is an H3 ######

Aperçu :


This is an H1

This is an H2

This is an H3


Citations

Balise HTML : <blockquote>

Markdown utilise le caractère > à la manière des citations de courrier électronique. Pour un rendu optimal, ajoutez manuellement un retour à la ligne et faites précéder chaque ligne d’un >.

Code :

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.

Aperçu :


This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.


Markdown autorise la version « paresseuse » : dans un paragraphe avec retours à la ligne manuels, seule la première ligne doit être précédée d’un >.

Code :

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

Aperçu :


This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.


Les citations peuvent être imbriquées (citation dans une citation) en augmentant le niveau de >.

Code :

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.

Aperçu :


This is the first level of quoting.

This is nested blockquote.

Back to the first level.


Une citation peut contenir d’autres éléments Markdown, notamment des titres, des listes et des blocs de code.

Code :

> ## This is a header.
>
> 1. This is the first list item.
> 2. This is the second list item.
>
> Here's some example code:
>
> return shell_exec("echo $input | $markdown_script");

Aperçu :


This is a header.

  1. This is the first list item.
  2. This is the second list item.

Here’s some example code:

return shell_exec("echo $input | $markdown_script");

Listes

Markdown supporte les listes ordonnées (numérotées) et non ordonnées (à puces).

Liste non ordonnée

Balise HTML : <ul>

Les listes non ordonnées utilisent l’astérisque (*), le signe plus (+) ou le tiret (-).

Code :

* Red
* Green
* Blue

Aperçu :


  • Red
  • Green
  • Blue

Équivalent à :

Code :

+ Red
+ Green
+ Blue

Ou :

Code :

- Red
- Green
- Blue

Liste ordonnée

Balise HTML : <ol>

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

Code :

1. Bird
2. McHale
3. Parish

Aperçu :


  1. Bird
  2. McHale
  3. Parish

Remarque : l’écriture suivante peut « déclencher accidentellement » une liste ordonnée :

Code :

1986. What a great season.

Aperçu :


  1. What a great season.

Vous pouvez échapper le point avec un antislash (\) :

Code :

1986\. What a great season.

Aperçu :


1986. What a great season.


Contenu indenté dans les listes

Citations dans un élément de liste

Pour placer une citation dans un élément de liste, le symbole > doit être indenté :

Code :

* A list item with a blockquote:
> This is a blockquote
> inside a list item.

Aperçu :


  • A list item with a blockquote:

    This is a blockquote inside a list item.


Blocs de code dans un élément de liste

Pour placer un bloc de code dans un élément de liste, il faut une double indentation — 8 espaces ou deux tabulations :

Code :

* A list item with a code block:
<code goes here>

Aperçu :


  • A list item with a code block:

    <code goes here>

Listes imbriquées

Code :

* A
* A1
* A2
* B
* C

Aperçu :


  • A
    • A1
    • A2
  • B
  • C

Blocs de code

Balise HTML : <pre>

Indentez chaque ligne du bloc de code d’au moins 4 espaces ou 1 tabulation.

Code :

This is a normal paragraph:
This is a code block.

Aperçu :


This is a normal paragraph:

This is a code block.

Un bloc de code continue jusqu’à la première ligne non indentée (ou la fin du document).

À l’intérieur d’un bloc de code, l’esperluette (&) et les chevrons (< >) sont automatiquement convertis en entités HTML.

Code :

<div class="footer">
&copy; 2004 Foo Corporation
</div>

Aperçu :


<div class="footer">
&copy; 2004 Foo Corporation
</div>

Les « Blocs de code clôturés » et la « Coloration syntaxique » présentés ci-dessous sont des syntaxes étendues que vous pouvez également utiliser pour écrire des blocs de code.

Blocs de code clôturés

Entourez le code de backticks appairés (comme indiqué ci-dessous) : l’indentation de quatre espaces n’est alors plus nécessaire.

Code :

Here's an example:
```
function test() {
console.log("notice the blank line before this function?");
}
```

Aperçu :


Here’s an example:

function test() {
console.log("notice the blank line before this function?");
}

Coloration syntaxique

Ajoutez un identifiant de langage optionnel après les backticks d’ouverture pour activer la coloration syntaxique (voir la liste des langages supportés).

Code :

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

Aperçu :


require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

Ligne horizontale

Balise HTML : <hr /> Placez trois tirets (-), astérisques (*) ou underscores (_) ou plus sur une même ligne. Des espaces entre les symboles sont autorisés.

Code :

* * *
***
*****
- - -
---------------------------------------
___

Aperçu :









Tableaux

Balise HTML : <table>

Il s’agit d’une syntaxe étendue.

Séparez les colonnes avec des barres verticales (|) et l’en-tête avec des tirets (-). Utilisez les deux-points (:) pour spécifier l’alignement.

Les barres verticales (|) encadrantes et l’alignement sont optionnels. Pour la séparation d’en-tête, chaque colonne nécessite au moins 3 tirets.

Code :

| Left | Center | Right |
|:-----|:------:|------:|
|aaa |bbb |ccc |
|ddd |eee |fff |
A | B
---|---
123|456
A |B
--|--
12|45

Aperçu :


LeftCenterRight
aaabbbccc
dddeeefff
AB
123456
AB
1245

Éléments en ligne

Liens

Balise HTML : <a>

Markdown supporte deux styles de liens : le lien en ligne et le lien de référence.

Lien en ligne

Format du lien en ligne : [texte](URL "titre")

Le titre est optionnel.

Code :

This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.

Aperçu :


This is an example inline link.

This link has no title attribute.


Pour référencer une ressource locale sur le même site, vous pouvez utiliser un chemin relatif :

Code :

See my [About](/about/) page for details.

Aperçu :


See my About page for details.


Lien de référence

Vous pouvez prédéfinir des références de liens. Format de définition : [id]: URL "titre"

Le titre est également optionnel. Pour utiliser la référence : [texte][id]

Code :

[id]: http://example.com/ "Optional Title Here"
This is [an example][id] reference-style link.

Aperçu :


This is an example reference-style link.


Remarques :

  • Les crochets contiennent l’identifiant du lien (insensible à la casse, avec une indentation possible de trois espaces maximum) ;
  • suivi de deux-points ;
  • puis d’un ou plusieurs espaces (ou tabulations) ;
  • puis de l’URL du lien ;
  • l’URL peut optionnellement être entourée de chevrons ;
  • suivi optionnellement d’un attribut titre, entouré de guillemets ou de parenthèses.

Les trois définitions suivantes sont équivalentes :

Code :

[foo]: http://example.com/ "Optional Title Here"
[foo]: http://example.com/ 'Optional Title Here'
[foo]: http://example.com/ (Optional Title Here)
[foo]: <http://example.com/> "Optional Title Here"

Si vous utilisez des crochets vides, le texte du lien lui-même sera utilisé comme nom.

Code :

[Google]: http://google.com/
[Google][]

Aperçu :


Google


Emphase

Balises HTML : <em>, <strong>

Markdown utilise l’astérisque (*) ou l’underscore (_) pour l’emphase. Un délimiteur correspond à <em> ; deux délimiteurs correspondent à <strong>.

Code :

*single asterisks*
_single underscores_
**double asterisks**
__double underscores__

Aperçu :


single asterisks

single underscores

double asterisks

double underscores


Cependant, si les délimiteurs sont entourés d’espaces, ils sont traités comme des caractères ordinaires et non comme de la syntaxe d’emphase.

Vous pouvez utiliser l’antislash pour les échapper :

Code :

\*this text is surrounded by literal asterisks\*

Aperçu :


*this text is surrounded by literal asterisks*


Code en ligne

Balise HTML : <code>

Entourez le code de backticks (`).

Code :

Use the `printf()` function.

Aperçu :


Use the printf() function.


Si le code en ligne doit contenir un backtick, utilisez des backticks multiples comme délimiteurs :

Code :

``There is a literal backtick (`) here.``

Aperçu :


There is a literal backtick (`) here.


Les délimiteurs d’un code en ligne peuvent inclure des espaces de chaque côté (un en début, un en fin), ce qui facilite l’insertion d’un backtick en début ou en fin de code :

Code :

A single backtick in a code span: `` ` ``
A backtick-delimited string in a code span: `` `foo` ``

Aperçu :


A single backtick in a code span: `

A backtick-delimited string in a code span: `foo`


Images

Balise HTML : <img />

La syntaxe des images en Markdown est similaire à celle des liens, et supporte les formes en ligne et de référence.

Image en ligne

Syntaxe de l’image en ligne : ![texte alternatif](URL "titre")

Le titre est optionnel.

Code :

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")

Aperçu :


Alt text
Alt text

Alt text
Alt text


Remarques :

  • Un point d’exclamation ! ;
  • suivi de crochets contenant le texte alternatif de l’image ;
  • suivi de parenthèses contenant l’URL ou le chemin de l’image, ainsi qu’un titre optionnel (entre guillemets).

Image de référence

Syntaxe de l’image de référence : ![texte alternatif][id]

Code :

[img id]: https://s2.loli.net/2024/08/20/5fszgXeOxmL3Wdv.webp "Optional title attribute"
![Alt text][img id]

Aperçu :


Alt text
Alt text


Texte barré

Balise HTML : <del>

Il s’agit d’une syntaxe étendue.

GFM ajoute la syntaxe du texte barré.

Code :

~~Mistaken text.~~

Aperçu :


Mistaken text.


Divers

Lien automatique

Markdown supporte une syntaxe raccourcie pour créer des « liens automatiques » (URL et adresses e-mail) : il suffit de les entourer de chevrons.

Code :

<http://example.com/>
<address@example.com>

Aperçu :


http://example.com/

address@example.com


GFM reconnaît automatiquement les URL standard et les convertit en liens.

Code :

https://github.com/emn178/markdown

Aperçu :


https://github.com/emn178/markdown


Échappement par antislash

Markdown vous permet d’utiliser l’antislash pour échapper les caractères spéciaux utilisés dans la syntaxe Markdown, afin qu’ils s’affichent littéralement.

Code :

\*literal asterisks\*

Aperçu :


*literal asterisks*


Les caractères suivants peuvent être échappés par un antislash pour être affichés littéralement :

Code:

\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark

HTML en ligne

Pour les balises non couvertes par la syntaxe Markdown, utilisez directement le HTML natif. Aucune déclaration de transition de Markdown vers HTML n’est nécessaire : écrivez simplement les balises.

Code :

This is a regular paragraph.
<table>
<tr>
<td>Foo</td>
</tr>
</table>
This is another regular paragraph.

Aperçu :


This is a regular paragraph.

Foo

This is another regular paragraph.


Remarque : la syntaxe Markdown n’est pas traitée à l’intérieur des balises HTML de bloc.

Contrairement aux balises de bloc, la syntaxe Markdown est traitée à l’intérieur des balises de niveau en ligne.

Code :

<span>**Work**</span>
<div>
**No Work**
</div>

Aperçu :


Work

**No Work**

Soutenir & Partager

Si cet article vous a aidé, partagez-le ou soutenez-moi !

Soutenir

Table des matières