Script d'ajout de frontmatter aux fichiers Markdown

Documentation technique

Description

Ce script Python ajoute automatiquement le frontmatter title et description aux fichiers Markdown qui n’en ont pas. Il est utilisé pour satisfaire les exigences de Starlight qui requiert que chaque fichier de documentation ait un titre.

Emplacement

/home/anderson/PP/apps/web/scripts/add_frontmatter.py

Fonctionnement

Le script parcourt les dossiers suivants :

/home/anderson/PP/GettingStarted
/home/anderson/PP/docs

Pour chaque fichier .md ou .mdx :

Vérifie si le fichier a déjà du frontmatter (commence par ---)
Si oui, ignore le fichier
Si non, extrait le titre :
- Préfère le premier H1 (# Titre) trouvé dans le contenu
- Fallback : utilise le nom de fichier en remplaçant les tirets/underscores par des espaces et en capitalisant
Supprime le H1 du contenu si le titre vient d’un H1 (pour éviter la duplication)

Ajoute le frontmatter suivant au début du fichier :

---
title: "Titre extrait"
description: "Documentation technique"
---

Utilisation

cd /home/anderson/PP/apps/web
python3 scripts/add_frontmatter.py

Quand l’utiliser

Après avoir ajouté de nouveaux fichiers Markdown dans GettingStarted ou docs
Si le build échoue avec l’erreur InvalidContentEntryDataError: title: Required
Avant de déployer sur Cloudflare

Notes

Le script ne modifie pas les fichiers qui ont déjà du frontmatter
La description est actuellement générique (“Documentation technique”) pour éviter les erreurs de parsing YAML
Les fichiers sans H1 reçoivent un titre basé sur leur nom de fichier