Créer un doc
Créez un fichier Markdown greeting.md
et placez-le dans le répertoire docs
.
website # répertoire racine de votre site
├── docs
│ └── greeting.md
├── src
│ └── pages
├── docusaurus.config.js
├── ...
---
description: Créer une page doc avec un contenu riche.
---
## Bonjour de Docusaurus
Êtes-vous prêt à créer le site de documentation de votre projet open source ?
## Les entêtes
s'afficheront sur la table des matières en haut à droite
Ainsi, vos utilisateurs sauront de quoi il s'agit sans faire défiler la page ou même sans trop la lire.
## Seuls les h2 et h3 seront par défaut dans la table des matières.
Vous pouvez configurer les niveaux d'entête de la table des matières soit par document, soit dans la configuration du thème.
Les entêtes sont bien espacés pour que la hiérarchie soit claire.
- Les listes vous aideront à
- présenter les points clés
- que vous voulez que vos utilisateurs retiennent
- et vous pouvez les imbriquer
- plusieurs fois
Tous les fichiers préfixés par un underscore (_
) sous le répertoire docs
sont traités comme des pages « partielles » et seront ignorés par défaut.
En savoir plus sur l'importation de pages partielles.
Frontmatter du doc
Le frontmatter est utilisée pour fournir des métadonnées supplémentaires pour votre page de doc. Le frontmatter est optionnel — Docusaurus pourra déduire toutes les métadonnées nécessaires sans le frontmatter. Par exemple, la fonctionnalité des tags de doc introduite ci-dessous nécessite l'utilisation de la frontmatter. Pour tous les champs possibles, consultez la documentation API.
Tags de doc
En option, vous pouvez ajouter des tags à vos pages de docs, ce qui introduit une autre dimension de catégorisation en plus de la barre latérale des docs. Les tags sont passés dans le frontmatter comme une liste de libellés :
---
id: doc-with-tags
title: Un doc avec des tags
tags:
- Démo
- Pour commencer
---
Les tags peuvent également être déclarés avec tags: [Demo, Pour commencer]
.
En savoir plus sur toutes les syntaxes possibles des tableaux Yaml.
Organisation de la structure du dossier
La façon dont les fichiers Markdown sont organisés sous le dossier docs
peut avoir plusieurs impacts sur la génération de contenu Docusaurus. Cependant, la plupart d'entre eux peuvent être découplés de la structure des fichiers.