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├── ...
En haut du fichier, indiquez id
et title
sur les premières lignes, afin que Docusaurus les reprenne correctement lors de la génération de votre site.
---id: greetingtitle: Bonjour---
## 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 dans la table des matières
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
### Entêtes avec id personnalisées {#custom-id}
Avec la syntaxe `{#custom-id}` vous pouvez définir votre propre identifiant d'entête.
Cela sera affiché dans le navigateur comme suit :
http://localhost:3000
Bonjour depuis Docusaurus
Êtes-vous prêt à créer le site de documentation pour 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 dans la table des matières
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
- et vous pouvez les imbriquer
#
Entêtes avec id personnaliséesAvec la syntaxe {#custom-id}
vous pouvez définir votre propre identifiant d'entête.