Introduction aux fonctionnalités de 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.

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.

important

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