markdown-formatting

Solid

Canonical markdown formatting conventions for diff-friendly documentation. Consult this skill when generating, editing, or reviewing markdown prose. Defines hybrid line wrapping, heading style, list spacing, and link conventions.

Code & Development 308 stars 27 forks Updated today MIT

Install

View on GitHub

Quality Score: 96/100

Stars 20%
83
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Markdown Formatting Conventions ## When To Use - Writing or editing any markdown documentation - Reviewing prose for line-wrapping compliance - Generating markdown from plugins (scribe, sanctum, etc.) ## When NOT To Use - Editing code blocks, tables, or frontmatter (these have their own formatting rules) - Quick scratch notes that will not be committed These conventions apply to all markdown documentation generated or modified by any plugin. The goal: produce prose that creates clean, reviewable git diffs and reads well on mobile devices. ## Quick Reference When writing or editing markdown prose: 1. **Wrap prose at 80 chars** using hybrid wrapping (prefer sentence/clause boundaries over arbitrary word breaks) 2. **Blank line before and after every heading** 3. **ATX headings only** (`# Heading`, never setext underlines) 4. **Blank line before every list** 5. **Reference-style links** when inline links push lines beyond 80 chars ## What to Wrap Wrap these content types at 80 characters: - Paragraphs (flowing prose text) - Blockquote text (the content after `>`) - List item descriptions (text after `- ` or `1. `) - Descriptions in definition lists ## What NOT to Wrap Never wrap or reflow these content types: - **Tables**: pipe-delimited rows stay on one line - **Code blocks**: fenced (` ``` `) or indented content - **Headings**: lines starting with `#` - **Frontmatter**: YAML/TOML between `---` or `+++` - **HTML blocks**: raw HTML elements - **Link defin...

Details

Author
athola
Repository
athola/claude-night-market
Created
6 months ago
Last Updated
today
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category