Fonctionnalités Markdown
La documentation est l'une des interactions entre votre produit et vos utilisateurs. Un ensemble de documents bien écrit et bien organisé aide vos utilisateurs à comprendre rapidement votre produit. Notre objectif est ici d'aider vos utilisateurs à trouver et à comprendre les informations dont ils ont besoin, le plus rapidement possible.
Docusaurus 2 utilise des outils modernes pour vous aider à composer facilement votre documentation intéractive. Vous pouvez intégrer des composants React, ou construire des blocs de codage en ligne dans lesquels vos utilisateurs peuvent jouer avec le code sur place. Commencez à partager vos moments de créativité avec le code dont votre public ne peut se passer. C'est peut-être le moyen le plus efficace d'attirer des utilisateurs potentiels.
Cette section suppose que vous utilisez les plugins officiels de contenu Docusaurus.
Standard features
Markdown est une syntaxe vous permettant d'écrire du contenu formaté dans une syntaxe lisible.
We use MDX as the parsing engine, which can do much more than just parsing standard Markdown syntax, like rendering React components inside your documents as well.
### Ma section du Doc
Message « Hello world » avec du texte en **gras**, du texte en _italique_ et un [link](/)

Markdown is declarative
Some may assume a 1-1 correlation between Markdown and HTML, e.g., 
will always become <img src="/img/docusaurus.png" alt="Preview" />
, as-is. However, that is not the case.
The Markdown syntax 
only declaratively tells Docusaurus that an image needs to be inserted here, but we may do other things like transforming a file path to URL path, so the generated markup may differ from the output of other Markdown renderers, or a naïve hand-transcription to the equivalent JSX/HTML code.
In general, you should only assume the semantics of the markup (```
fences become code blocks; >
becomes quotes, etc.), but not the actual compiled output.
Front matter
Le frontmatter est utilisé pour ajouter des métadonnées à votre fichier Markdown. Tous les plugins de contenu ont leur propre schéma de frontmatter, et utilisent le frontmatter pour enrichir les métadonnées par défaut déduites du contenu ou d'une autre configuration.
Front matter is provided at the very top of the file, enclosed by three dashes ---
. The content is parsed as YAML.
---
title: Mon titre de doc
plus_de_donnees:
- peut être fourni
- comme: objets
ou: tableaux
---
Quotes
Les citations Markdown sont joliment stylisées :
> Easy to maintain open source documentation websites.
>
> — Docusaurus
Easy to maintain open source documentation websites.
— Docusaurus
Details
Markdown can embed HTML elements, and details
HTML elements are beautifully styled:
### Details element example
<details>
<summary>Toggle me!</summary>
<div>
<div>This is the detailed content</div>
<br/>
<details>
<summary>
Nested toggle! Some surprise inside...
</summary>
<div>😲😲😲😲😲</div>
</details>
</div>
</details>
Details element example
Toggle me!
Nested toggle! Some surprise inside...
En pratique, il ne s'agit pas vraiment d'éléments HTML, mais d'éléments React JSX, que nous aborderons ensuite !