Spécificités Markdown

MarkDocs est basée sur Fumadocs, qui supporte la majorité des éléments communs utilisée en Markdown et qui en ajoute d’autres via leur syntaxe MDX. MarkDocs ajoute également d’autres éléments personnalisés.

Custom anchor

Il est possible de modifier le « hash » (identifiant d’un titre au sein d’une page, permet de défiler directement vers l’élément lorsqu’on clique dessus puis partage l’URL de la page) en l’indiquant à la fin après un ^.

### Sous-titre ^subtitle-id

Composants personnalisés

Les composants Fumadocs sont utilisables depuis votre documentation en insérant le code dans un bloc de code portant le langage component.

\```component
<Steps>
	<Step>
		### Hello World
	</Step>

	<Step>
		### Hello World
	</Step>
</Steps>
\```

Images

![Texte alternatif](nom_de_l_image.png)

Callouts

> [!error] Title
> Contents
 
> [!warning] Title
> Contents
 
> [!info] Title
> Contents