conventions-markdown
Markdown Conventions
Write Markdown that reads well, renders correctly on GitHub, and uses inclusive language.
Formatting. Wrap prose at 80 columns by hand. Format with
mdformat --number, which keeps ordered lists numbered 1, 2, 3, never with
--wrap, which breaks GitHub alert blocks. Never run mdformat on files an
agent reads: skills (**/skills/**), prompts (**/prompts/**), and
AGENTS.md, CLAUDE.md, or GEMINI.md. It collapses the 4-backtick fences
that protect nested code blocks and strips deliberate layout, so format those
by hand and keep their lists numbered 1, 2, 3. Install it with
pipx install mdformat and
pipx inject mdformat mdformat-gfm mdformat-frontmatter.
Label lines. GitHub joins consecutive lines into one paragraph, so a stack
of **Label:** value lines renders as one run-on line. Make them a bullet
list instead of forcing breaks with a trailing \ or spaces: