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 vos documentations interactives. 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.

Dans cette section, nous aimerions vous présenter les outils que nous avons choisis qui, selon nous, vous aideront à construire une documentation puissante. Laissez-nous vous guider avec un exemple.

important

Cette section suppose que vous utilisez les plugins officiels de contenu Docusaurus.

Fonctionnalités standard

Markdown est une syntaxe vous permettant d'écrire du contenu formaté dans une syntaxe lisible.

La syntaxe standard Markdown est supporté et nous utilisons MDX comme moteur d'analyse, qui peut faire bien plus que simplement l'analyse de Markdown, tel que le rendu des composantes React dans vos documents.

### Ma section du Doc
Message « Hello world » avec du texte en **gras**, du texte en _italique_ et un [link](/)
![img alt](/img/docusaurus.png)

Ma section du Doc

Message « Hello world » avec du texte en gras, du texte en italique et un link

Citations

Les citations Markdown sont joliment stylisées :

> Ceci est une citation

Ceci est une citation

Détails

Markdown peut intégrer des éléments HTML, et les éléments HTML details sont joliment stylisés :

### Exemple d'élément de détails
<details>  <summary>Changez-moi !</summary>  <div>    <div>Ceci est le contenu détaillé</div>    <details>      <summary>        <div>Détail imbriqué !</div>        <div>Quelques surprises à l'intérieur...</div>      </summary>      <div>        😲😲😲😲😲      </div>    </details>  </div></details>

Exemple d'élément de détails

Changez-moi !

Ceci est le contenu détaillé

Détail imbriqué !

Quelques surprises à l'intérieur...

😲😲😲😲😲

remarque

En pratique, il ne s'agit pas vraiment d'éléments HTML, mais d'éléments React JSX, que nous aborderons ensuite !