Aller au contenu principal

Ajouter une page de documentation

Voir aussi le glossaire Docusaurus pour les notions comme frontmatter, doc ID, sidebar ou slug.

Étape 1 — CrĂ©er le fichier Markdown​

Créez un fichier .md dans le dossier docs à l'emplacement souhaité.

Exemple : ajouter une page dans la section VCF Automation

docs/vcf-automation/10_ma_nouvelle_page.md

Conseil de nommage : utilisez le préfixe numérique 10_, 11_, etc. pour maintenir l'ordre visuel dans le dépÎt.

Étape 2 — RĂ©diger l'en-tĂȘte de la page​

Chaque page doit commencer par un bloc frontmatter entre --- :

---
title: Titre de ma page
---

# Titre de ma page

Contenu ici...

Le champ title est utilisé par Docusaurus pour le titre de l'onglet navigateur et les métadonnées. Le # Titre dans le corps est ce qui s'affiche sur la page.

Étape 3 — Ajouter des liens vers d'autres pages​

Lien vers une autre page de doc (mĂȘme dossier)​

[Voir l'overview](./01_overview.md)

Lien vers une page de reference de la section​

[Voir le glossaire Docusaurus](./GLOSSARY.md)

Lien vers une section prĂ©cise d'une page​

Les ancres sont générées automatiquement à partir des titres. Un titre ## Mon titre devient #mon-titre.

[Voir la section Sizing](./05_sizing_ha_multisite.md#sizing)

Lien externe​

[Documentation Broadcom](https://docs.broadcom.com)

Lien vers une image​

Les images se placent dans static/img/ et se référencent avec un chemin absolu :

![Description de l'image](/img/mon-image.png)

Étape 4 — Ajouter la page dans sidebars.js​

C'est l'Ă©tape obligatoire : sans cette modification, la page n'apparaĂźtra pas dans la sidebar.

Ouvrez sidebars.js et localisez la section correspondante. Ajoutez une entrée { type: 'doc', ... } :

// Avant
items: [
  { type: 'doc', id: 'vcf-automation/09_limitations_kb', label: '09 — Limitations & KBs' },
],

// AprĂšs
items: [
  { type: 'doc', id: 'vcf-automation/09_limitations_kb', label: '09 — Limitations & KBs' },
  { type: 'doc', id: 'vcf-automation/10_ma_nouvelle_page', label: '10 — Ma nouvelle page' },
],

Le doc ID correspond au chemin du fichier sans l'extension .md, relatif au dossier docs/.

Étape 5 — VĂ©rifier dans le navigateur​

Si le serveur local tourne (npm run start), le rechargement est automatique. VĂ©rifiez que :

  • La page apparaĂźt dans la sidebar Ă  la bonne position
  • Le titre s'affiche correctement
  • Les liens pointent vers les bonnes pages (pas de page 404)