doc-frontmatter

Generate and validate YAML frontmatter metadata for Markdown documents in docs folders.

1|Updated May 18, 2025

Search Tags:#automation #markdown #validation #yaml #metadata #docs #frontmatter

Ready to run

npx skills add https://github.com/practical-stack/astro-blog-kit --skill doc-frontmatter

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-frontmatter
Source: https://github.com/practical-stack/astro-blog-kit/tree/main/.claude/skills/doc-frontmatter
Command: npx skills add https://github.com/practical-stack/astro-blog-kit --skill doc-frontmatter

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Generate and validate YAML frontmatter for docs folder documents.

Core Features & Use Cases

Auto-populate title, description, type, and tags from content.
Validate frontmatter against the defined schema and relationships.
Apply to single documents or entire folders to maintain consistency.

Quick Start

Run the generate-frontmatter script on a Markdown file to create frontmatter, then validate it with the validate-frontmatter script.

Frequently Asked Questions about doc-frontmatter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automatically generate YAML frontmatter for Markdown files in a docs folder?▼

Validate YAML frontmatter by running a validation script that checks metadata fields against a defined schema. It verifies required fields and optional relationship links like depends_on, related, and used_by to ensure structural consistency across your documentation.

Can I automatically add relationship fields like depends_on and related to my Markdown frontmatter?▼

Yes, you can add optional relationship fields like depends_on, related, and used_by to YAML frontmatter. The generation script analyzes content and applies these fields to map document relationships within the docs folder structure.

Do I need any external dependencies to validate frontmatter schema in my docs directory?▼

No external dependencies are required to validate frontmatter schema. The skill operates independently using internal scripts to analyze content, generate metadata, and validate YAML frontmatter against its defined schema.

Why does my Markdown frontmatter validation fail when processing multiple files in a folder?▼

Frontmatter validation fails when Markdown files lack required metadata fields or contain invalid YAML structures. Running the validation script identifies schema mismatches in title, description, type, tags, or relationship fields across the folder.