format-markdown

Validate and format Markdown files against RULE_Markdown.md and RULE_Document.md.

1|Updated Feb 19, 2025
One-click install
npx skills add https://github.com/cahyaong/ai.odin --skill format-markdown
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: format-markdown
Source: https://github.com/cahyaong/ai.odin/tree/main/.ai-toolbox/skills/format-markdown
Command: npx skills add https://github.com/cahyaong/ai.odin --skill format-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill validates and formats Markdown files to conform with project documentation standards, reducing manual review time and ensuring consistency across docs.

Core Features & Use Cases

  • Validation: Checks Markdown structure against RULE_Markdown.md and RULE_Document.md.
  • Formatting: Applies consistent heading levels, TOC integrity, and frontmatter presence.
  • Use Case: Prepare repository documentation for review or publication by automatically aligning with project guidelines.

Quick Start

Use the format-markdown skill to validate and format a file like 'README.md' to conform to project rules.

Frequently Asked Questions about format-markdown

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

FAQPage Schema
How do I validate markdown documentation structure before publishing?

To validate markdown documentation structure, you can use automated linting against project rules to check heading numbering, frontmatter presence, and TOC integrity before publication.

What does markdown formatting enforce for repository documentation?

Markdown formatting enforces documentation standards by applying consistent heading levels, validating table of contents integrity, and checking frontmatter presence across repository files.

Can I automatically fix markdown heading numbering and frontmatter issues?

Yes, you can automatically fix markdown heading numbering and frontmatter issues by formatting files against predefined documentation rules to align stylistic structure automatically.

Do I need specific rule files to lint markdown for consistent structure?

Yes, validating markdown for consistent structure requires specific rule files like RULE_Markdown.md and RULE_Document.md to enforce project guidelines during the review workflow.

What is the best way to check table of contents integrity in markdown files?

The best way to check table of contents integrity in markdown files is to use an automated validation tool that evaluates the document structure against established formatting rules.