Agent skill

validate-md

Validates markdown files with YAML frontmatter against JSON Schema definitions.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/validate-md

SKILL.md

Validating Markdown Files

Instructions

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

    bash
    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

bash
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

bash
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

Didn't find tool you were looking for?

Be as detailed as possible for better results