Validation de fichiers Markdown

VérifiéSûr

Valide les fichiers Markdown avec frontmatter YAML par rapport à des schémas JSON. Exécutez un script Python dans un répertoire contenant schema.yaml pour vérifier que tous les fichiers sont conformes. Utile pour maintenir la cohérence de contenu structuré.

Spar Skills Guide Bot
DocumentationDébutant
02/06/2026
Claude Code
#markdown-validation#yaml-frontmatter#json-schema#content-quality

Recommandé pour

Synthèse automatique

Valide des fichiers Markdown avec frontmatter YAML contre des schémas JSON Schema.

Points forts

  • Automatise la vérification de la qualité du contenu structuré dans les fichiers Markdown.
  • Fournit des messages d'erreur clairs avec le chemin du champ et le fichier concerné.
  • Simple d'utilisation avec une seule commande en ligne.

Limites

  • Nécessite un fichier schema.yaml dans le répertoire cible.
  • Dépend de Python et des bibliothèques pyyaml et jsonschema.
  • Ne vérifie que le frontmatter YAML, pas le contenu Markdown lui-même.
Quand l'utiliser

Pour valider des fichiers Markdown structurés avec des métadonnées YAML (ex: fiches CRM, documentation technique) de manière reproductible.

Quand l'éviter

Pour valider du contenu Markdown libre sans frontmatter ou lorsque le schéma est inconnu.

Analyse de sécurité

Sûr
Score qualité85/100

The skill instructs running a Python validation script on markdown files; no destructive, exfiltrating, or obfuscated actions are present. The script is not included, but the skill itself contains no malicious instructions.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Validate all files in a directory
Run validation on the crm/contacts directory to check all markdown files against the schema.
Fix a missing required field
Validate the crm/opportunities directory and fix any missing required fields like 'stage'.

name: validate-md description: Validates markdown files with YAML frontmatter against JSON Schema definitions. allowed-tools: [Bash, Read, Glob]

Validating Markdown Files

Instructions

  1. Run validation script for the target directory containing a schema.yaml file:

    python validate-md.py <directory>
    
  2. Review results:

    • Success: ✓ OK: filename.md is valid
    • Errors: Shows validation error, field path, and file location

Examples

Example 1: Validate contacts directory

python validate-md.py crm/contacts

Output:

✓ OK: smith-john.md is valid
✓ OK: doe-jane.md is valid
✓ SUCCESS: All 2 files are valid!

Example 2: Validation error - missing required field

python validate-md.py crm/opportunities

Output:

❌ deal-2024-q1.md validation error: 'stage' is a required property
   In file: crm/opportunities/deal-2024-q1.md

Fix: Add stage: qualified to the frontmatter.

Scripts

  • validate-md.py the python validation script

Required Python Packages

  • pyyaml - for parsing YAML frontmatter
  • jsonschema - for validating against JSON Schema

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/markdown-file-validation-mm8o52n2/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/markdown-file-validation-mm8o52n2' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/markdown-file-validation-mm8o52n2/download' --output '.skill-downloads/markdown-file-validation-mm8o52n2/SKILL.md.part' && mv '.skill-downloads/markdown-file-validation-mm8o52n2/SKILL.md.part' '.skill-downloads/markdown-file-validation-mm8o52n2/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/markdown-file-validation-mm8o52n2/SKILL.md' && test -s '.skill-downloads/markdown-file-validation-mm8o52n2/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/validate-md' && cp -R '.skill-downloads/markdown-file-validation-mm8o52n2' '.claude/skills/validate-md'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/markdown-file-validation-mm8o52n2'

openskills read 'markdown-file-validation-mm8o52n2'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/markdown-file-validation-mm8o52n2/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires