markdown-content

Enforce Markdown formatting, structure, and YAML front matter standards.

1|Updated Jun 12, 2024
One-click install
npx skills add https://github.com/cskiwi/badman-m3 --skill markdown-content-cskiwi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-content
Source: https://github.com/cskiwi/badman-m3/tree/main/.claude/skills/markdown-content
Command: npx skills add https://github.com/cskiwi/badman-m3 --skill markdown-content-cskiwi

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures all Markdown files adhere to consistent formatting, structure, and front matter requirements, improving readability and maintainability of documentation.

Core Features & Use Cases

  • Standardized Formatting: Enforces rules for headings, lists, code blocks, links, images, tables, and line length.
  • Front Matter Validation: Ensures required YAML front matter is present and correctly formatted.
  • Use Case: When contributing to a project's documentation, this Skill can be used to automatically check your .md files for compliance with the project's style guide before you commit, preventing style inconsistencies.

Quick Start

Use the markdown-content skill to review the attached document 'README.md' for formatting compliance.

Frequently Asked Questions about markdown-content

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

FAQPage Schema
How do I enforce documentation and content creation standards for Markdown files?

You can enforce Markdown formatting standards by validating headings, lists, code blocks, links, images, tables, line length, whitespace, and YAML front matter in .md and .mdx files.

Can I validate YAML front matter requirements in my .mdx files?

Yes, front matter validation ensures required YAML metadata in .md and .mdx files is present and correctly formatted before you commit documentation updates.

How do I check Markdown formatting compliance before committing documentation?

Review your .md files against a style guide to automatically check formatting compliance, preventing style inconsistencies in headings, lists, and code blocks.

What Markdown structure and formatting rules does this validation cover?

Markdown structure validation covers specific rules for headings, lists, code blocks, links, images, tables, line length, whitespace, and front matter requirements.

Does this formatting validation work with both .md and .mdx files?

Yes, Markdown content validation applies to the creation and editing of both .md and .mdx files to ensure consistent documentation readability and maintainability.