Markdown Style Guide

Apply these rules to every piece of Markdown you produce or reformat.

Core Principles

• Write for a senior engineering audience: clean, precise, no fluff.
• Formatting exists to aid comprehension, not to decorate.
• When in doubt, use less formatting.

Line Width

Never hard-wrap lines at a fixed column width. Every prose line -- paragraphs, list items, block quotes, table cells -- must be a single unbroken line. Let the renderer handle wrapping. This applies everywhere in the document without exception: do not wrap at 80, 100, 120, or any other column limit.

The only text that may contain newlines is content inside fenced code blocks, where newlines are part of the code itself.

Prohibited Formatting