skills.rest
p-iknow
p-iknowCOMMUNITY
Explore all skills by this author →
Website𝕏@p__stackGitHub

doc-frontmatter

Generate and validate YAML frontmatter for Markdown documentation files.

1|Updated Feb 15, 2026
Search Tags:#documentation#yaml#metadata#docs#generate#validate#frontmatter
One-click install
npx skills add https://github.com/p-iknow/fullstack-forge --skill doc-frontmatter-p-iknow
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-frontmatter
Source: https://github.com/p-iknow/fullstack-forge/tree/main/.claude/skills/doc-frontmatter
Command: npx skills add https://github.com/p-iknow/fullstack-forge --skill doc-frontmatter-p-iknow

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Ensures Markdown documentation files in a repository have complete, consistent, and schema-compliant YAML frontmatter so docs are discoverable, searchable, and consumable by tooling and AI embeddings.

Core Features & Use Cases

  • Generate Frontmatter: Create a YAML frontmatter block by extracting title from the first H1 or filename, deriving a 50–160 character description from the first paragraph, and inferring document type via content heuristics.
  • Validate & Repair: Check required fields, enforce controlled tag vocabulary and limits, verify types and relationship arrays, and warn about description length or unknown tags.
  • Use Case: Run auto-generation for a new guide or bulk-validate an existing docs/ folder before a release to ensure consistent metadata for search, site generation, and AI embeddings.

Quick Start

Generate YAML frontmatter for docs/01-foundation/00-setup.md and validate it against the schema using the provided scripts.

Frequently Asked Questions about doc-frontmatter

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

FAQPage Schema
How do I generate YAML frontmatter for markdown documentation files?▼

To generate YAML frontmatter, the tool extracts the document title from the first H1 heading or filename, derives a 50-160 character description from the initial paragraph, and infers the document type using content heuristics.

How do I validate YAML frontmatter against a controlled tag vocabulary?▼

You can validate YAML frontmatter by checking required fields, enforcing a controlled tag vocabulary with a limit of up to five tags, verifying field types, and validating relationship arrays against the schema.

What is YAML frontmatter used for in markdown documentation?▼

YAML frontmatter ensures markdown documentation files are discoverable, searchable, and consumable by tooling and AI embeddings by providing complete, consistent, and schema-compliant metadata.

Can I bulk-validate an existing docs folder for missing frontmatter fields?▼

Yes, you can run bulk-validation across an existing docs folder to check required fields, warn about description length or unknown tags, and ensure consistent metadata before a release.

What are the limitations when inferring document type via content heuristics?▼

The tool infers document type via content heuristics and enforces up to five controlled tags, warning about description length or unknown tags, but relies entirely on existing markdown content accuracy.

Related Skills

Explore More Software Engineering Skills→
bodangrenbodangren
11

doc-indexer

Scan Markdown files in docs/ and extract YAML frontmatter metadata.

Community
Basic
ToXMonToXMon

tone-style-enforcer

Extract style profiles and validate text against YAML style guides.

Community
Intermediate
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced
jacob-balslevjacob-balslev
1

markdown-post-frontmatter-validation

Validate Markdown post YAML frontmatter for required fields and schema rules.

Community
Intermediate