Script d'ajout de frontmatter aux fichiers Markdown
Description
Section titled â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
Section titled âEmplacementâ/home/anderson/PP/apps/web/scripts/add_frontmatter.py
Fonctionnement
Section titled â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
- PréfÚre le premier H1 (
- 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
Section titled âUtilisationâcd /home/anderson/PP/apps/webpython3 scripts/add_frontmatter.pyQuand lâutiliser
Section titled âQuand lâutiliserâ- AprĂšs avoir ajoutĂ© de nouveaux fichiers Markdown dans
GettingStartedoudocs - Si le build Ă©choue avec lâerreur
InvalidContentEntryDataError: title: Required - Avant de déployer sur Cloudflare
- 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