Markdown Formatting
Apply consistent Markdown formatting to all outputs, structuring content for readability and professionalism. This skill ensures that PR descriptions, issue bodies, documentation, and notes all follow the same formatting conventions with proper headings, lists, code blocks, and emphasis.
Installation
Add the marketplace and install this skill:
/plugin marketplace add britt/claude-code-skills
/plugin install britt/markdown-formatting
Or install all skills at once:
/plugin install britt/claude-code-skills
Compatibility
| Platform | Supported |
|---|---|
| Claude Code | ✓ |
| Claude.ai | ✓ |
How to use it
Use this skill when:
- Writing PR descriptions or issue bodies
- Producing documentation and guides
- Creating notes and summaries
- Formatting any structured text output for consistency
Features
Lead-with-the-point structure Every document starts with a TL;DR or summary, followed by details. Headings, lists, and whitespace are used to aid scanning.
Context-aware templates Provides ready-made templates for PR descriptions (with summary, changes, and test plan) and issue bodies (with problem, steps to reproduce, expected, and actual).
Consistent formatting rules Enforces dash-style unordered lists, numbered ordered lists, language-identified code blocks, proper heading hierarchy, and descriptive link text.
Anti-pattern detection Identifies common mistakes like walls of text, mixed list markers, code blocks without language identifiers, and headings used as emphasis.