Gérer le bouton List docs
Voir aussi le glossaire Docusaurus pour les notions comme List docs, breadcrumb, navbar et sidebar.
Cette procédure explique à quoi sert le bouton List docs en haut des pages de documentation, et comment il se configure.
À quoi sert List docs
Le bouton List docs renvoie vers la page racine de la documentation, soit /docs.
Il permet de revenir rapidement à la vue d'ensemble des sections disponibles.
Étape 1 — Vérifier la page d'accueil Docs
La page cible de List docs est la page docs/index.md.
Vérifie qu'elle contient bien les sections principales et des liens valides.
Étape 2 — Ajouter ta section dans la page d'accueil docs
Quand tu crées une nouvelle section (exemple: Guide Docusaurus), ajoute-la dans docs/index.md.
Exemple de lien valide vers une page d'index de dossier:
[Guide Docusaurus](/docs/docusaurus)
Bon format:
/docs/docusaurus/docs/vcf-automation
Formats à éviter:
/docs/docusaurus/index/docs/vcf-automation/README
Étape 3 — Vérifier la sidebar de la section
Le bouton List docs renvoie à /docs, mais la navigation interne dépend de la sidebar.
Après ajout d'une page:
- Ajouter l'entrée dans
sidebars.js - Vérifier l'ID (sans extension
.md) - Vérifier le nom affiché (
label)
Étape 4 — Vérifier la navigation du header / navbar
Pour que la section soit visible aussi dans le menu Docs du header, vérifier docusaurus.config.js.
Exemple de lien correct:
{ label: 'Guide Docusaurus', to: '/docs/docusaurus' }
Étape 5 — Tester en local
Depuis devs/web-site:
npm start
npm run build
Notes d'usage :
npm startlance le serveur de dev et garde le terminal occupé.- Pour lancer
npm run build, utiliser un second terminal ou arrêternpm startavecCtrl + C. npm run buildpeut être lancé directement sansnpm start.
Checklist:
- Le bouton List docs renvoie vers
/docs - La section apparaît bien dans la page
/docs - Tous les liens de la section sont cliquables
- Le build ne remonte pas de broken links
Si tout est vert, la configuration est correcte.