Notre avis
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.
Pour valider des fichiers Markdown structurés avec des métadonnées YAML (ex: fiches CRM, documentation technique) de manière reproductible.
Pour valider du contenu Markdown libre sans frontmatter ou lorsque le schéma est inconnu.
Analyse de sécurité
SûrThe 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é
Exemples
Run validation on the crm/contacts directory to check all markdown files against the schema.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
-
Run validation script for the target directory containing a
schema.yamlfile:python validate-md.py <directory> -
Review results:
- Success:
✓ OK: filename.md is valid - Errors: Shows validation error, field path, and file location
- Success:
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.pythe python validation script
Required Python Packages
- pyyaml - for parsing YAML frontmatter
- jsonschema - for validating against JSON Schema
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Créer un diagramme Excalidraw
Documentation
Générer un diagramme Excalidraw à partir d'une description textuelle que l'utilisateur peut importer dans Excalidraw.