Aller au contenu principal
Version: 2.0.0-beta.9

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: greeting
title: 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 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

### 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.

Seul les h2 et h3 seront dans le toc par défaut.

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

Entêtes avec id personnalisées

Avec la syntaxe {#custom-id} vous pouvez définir votre propre identifiant d'entête.

remarque

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.

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
---
tip

Les tags peuvent également être déclarés avec tags: [Demo, Pour commencer].

En savoir plus sur toutes les syntaxes possibles des tableaux Yaml.