Syntaxe des jetons#

Cette page sert de référence pour la syntaxe de MyST Markdown.

Voir aussi

Pour plus de description et d’explication de la syntaxe de MyST, voir le guide de syntaxe.

1.  Jetons de bloc (multilignes)#

Les jetons de bloc couvrent plusieurs lignes de contenu. Ils sont divisés en deux sections :

  • Jetons de blocs étendus contient des tokens extra qui ne sont pas dans CommonMark.

  • commonmark-block-tokens contient des jetons CommonMark qui fonctionnent aussi, pour référence.

Note

Parce que MyST markdown a été inspiré par des fonctionnalités qui existent dans reStructuredText, nous avons indiqué ci-dessous la syntaxe équivalente de rST pour de nombreuses fonctionnalités de MyST markdown.

1.1.  Jetons de blocs étendus#

Jeton

Description

Exemple

Entête

Un bloc YAML au début du document entouré de ---

 
---
⟨clé⟩: ⟨valeur⟩
---

Directives

Encadrées par au moins 3 « backticks », suivis du nom de la directive entre accolades {}. Plus de détails ici.

 
```{⟨directive⟩}
:⟨option⟩: ⟨valeur⟩

⟨Contenu⟩
```

Math

Mathématiques sur plusieurs lignes. Environnements d’amsmath possibles. Plus de détails ici.

 
$$
\mathrm{e}^{\mathrm{i}\pi}+1=0
$$

Tableau

Style de tableau Markdown standard, avec séparation des colonnes par caractères « pipe » (|).

 
| a | b |
|:--|--:|
| c | d |

Ligne commentée

Une ligne commentée. Voir Commentaires pour plus d’informations.

 
% ceci est un commentaire

Coupures thématiques

Définit les blocs de texte. Voir Coupures thématiques pour plus d’informations.

 
+++ {"meta": "data"}

Note de bas de page

Définition d’une note de bas de page de référence, placée au bas du document. Plus de détails ici.

 
[^ref] : Un texte de note de bas de page

Admonitions

Syntaxe alternative pour les admonitions (seulement).

 
:::{note}
⟨Contenu⟩
:::

« Span » HTML

Tout code HTML valide (rendu dans la sortie HTML uniquement)

 
<p>Bla bla</p>

Échappement

Symboles échappés (non interprétés)

 
\*

Liens automatiques

Liens apparaissant dans la sortie finale

 
<https://ctan.org/>

Extraits de code

Texte restitué verbatim

 
`a=1`

Coupure de ligne

Se terminant par un espace ou une barre oblique inverse

 
Retour à la ligne\

Image

Lien vers une image. Plus de détails ici

 
![alt](src "title")

Lien

Voir Références croisées pour plus de détails.

 
[texte](cible "titre") ou [texte][clé]

Gras

Texte en gras

 
**⟨texte en gras⟩**

Emphase

Texte en italique

 
*⟨texte en emphase⟩*

Texte brut

Tout texte

 
⟨N'importe quel texte⟩