Aller au contenu principal

Modifier une page de documentation

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

Étape 1 — Modifier le contenu​

Ouvrez le fichier .md correspondant dans docs/ et modifiez le contenu librement.

Rappel : le Markdown supporte les tableaux, blocs de code, listes, titres, gras, italique, etc.

## Mon nouveau titre

Nouveau contenu avec **texte en gras** et `code inline`.

| Colonne 1 | Colonne 2 |
|---|---|
| Valeur A | Valeur B |

Étape 2 — Modifier le titre de la page​

Le titre affiché dans la sidebar vient de deux endroits selon les cas :

A — Modifier le titre dans le contenu​

Changez le champ title dans le frontmatter et/ou le # Titre dans le corps :

---
title: Mon nouveau titre
---

# Mon nouveau titre

B — Modifier le label dans sidebars.js​

Le sidebar label est défini indépendamment dans sidebars.js. Si vous changez le titre de la page, pensez à mettre à jour le label :

// Avant
{ type: 'doc', id: 'vcf-automation/01_overview', label: '01 — Vue d\'ensemble' },

// Après
{ type: 'doc', id: 'vcf-automation/01_overview', label: '01 — Vue d\'ensemble (mis à jour)' },

Étape 3 — Modifier ou mettre à jour des liens​

Vérifier un lien existant​

Cherchez dans le fichier les occurrences de [texte](lien) et mettez à jour la cible si nécessaire.

Changer la destination d'un lien interne​

<!-- Avant -->
[Voir l'ancienne page](./04_ancien_nom.md)

<!-- Après -->
[Voir la nouvelle page](./04_nouveau_nom.md)

Changer le texte d'un lien sans changer la destination​

<!-- Avant -->
[Cliquez ici](./01_overview.md)

<!-- Après -->
[Voir la vue d'ensemble](./01_overview.md)

Étape 4 — Cas particulier : renommer ou déplacer un fichier​

Attention : renommer ou déplacer un fichier casse tous les liens qui pointent vers lui.

Procédez dans cet ordre :

  1. Renommez le fichier dans docs/
  2. Mettez à jour le doc ID dans sidebars.js
  3. Recherchez dans tout le dossier docs/ les références à l'ancien nom de fichier et corrigez-les

Pour trouver toutes les références, utilisez la recherche VS Code :

  • Raccourci : Ctrl+Shift+F
  • Cherchez l'ancien nom du fichier (sans extension), par exemple : 04_ancien_nom

Étape 5 — Vérifier dans le navigateur​

Si le serveur local tourne (npm run start), vérifiez que :

  • Le contenu modifié s'affiche correctement
  • Le sidebar label est à jour si vous l'avez modifié
  • Aucun lien ne mène vers une page 404