skills/smithery.ai/Markdown Documentation Standards

Markdown Documentation Standards

SKILL.md

Markdown Documentation Standards

When to Use

This skill auto-activates when working on markdown files and provides comprehensive guidelines for creating professional, accessible, and well-structured documentation.

Purpose

Enforce documentation and content creation standards for all markdown files in the project.


Core Markdown Rules

1. Heading Hierarchy

  • Never use H1 (#) - H1 is auto-generated from the document title
  • Use H2 (##) for main sections - Primary organizational level
  • Use H3 (###) for subsections - Secondary organizational level
  • Avoid H4 and beyond - If needed, consider restructuring content
  • Maintain proper hierarchy - Don't skip levels (e.g., H2 → H4)
Installs
First Seen