coding-markdown
When markdown being written or edited
When & Why to Use This Skill
This Claude skill enforces strict, minimalist Markdown formatting standards to ensure clean, professional, and highly readable documentation. It optimizes content by streamlining vertical spacing, standardizing list typography, and simplifying file references, making it an essential tool for technical writers and developers who prioritize information density and clarity.
Use Cases
- Technical Documentation: Automatically apply a consistent minimalist style to README.md files and project documentation to maintain a professional look.
- AI Output Standardization: Ensure that AI-generated responses follow specific formatting rules, such as using ')' for lists and avoiding redundant Markdown links.
- Codebase Referencing: Clean up file path mentions in documentation by removing noisy line numbers and converting complex links into simple, readable backticks.
- Content Refactoring: Quickly reformat existing Markdown files to meet high-density spacing standards and uniform indentation requirements.
| name | coding-markdown |
|---|---|
| description | When markdown being written or edited |
Markdown Instructions
Vertical Spacing
- Minimal empty lines between sections
- No empty lines between related list items
- Headers immediately followed by content
- Single empty line between major sections only
Formatting Rules
Strictly enforce the following formatting for all file paths and references to reduce noise:
- No Markdown Links: Never use name syntax. Use plain backticks only.
- No Line Numbers: Strip all line number suffixes (e.g., :22).
- No Redundancy: Do not repeat the filename in brackets and parentheses.
- Contextual Pointers: When referencing specific sections, name the section instead of using line numbers.
Examples:
Bad: app/models/user.py
Good:
app/models/user.pyBad: user.py Good:app/models/user.pyBad: See.roo/rules/01-general.mdGood: SeeCritical Resourcesin.roo/rules/01-general.md
Formatting Standards
Strictly enforce the following minimalist formatting rules. Style & Typography
- References: Use inline code backticks (e.g.,
file.py) for files and code. Never use brackets or links. - Indentation: Use exactly 4 spaces for nested items. Lists & Spacing
- Numbering: Use
)as the separator (e.g.,1),2)). Never use periods (1.). - Density: No empty lines between list items. Group related items tightly.
- Headers: Content must start on the very next line after a header. Do not insert an empty line. Examples Bad (Wrong list style, extra spacing):
## Analysis
**Points**:
1. First item
2. Second item
Good (Compact, correct list style):
## Analysis
**Points**:
1) First item
- Nested detail
2) Second item