writing-style-markdown

What problem does it solve?

Establishes consistent, readable Markdown conventions so documentation and notes remain easy to edit, review, and render across tools and teams.

Core Features & Use Cases

• Bullet-first lists: Prefer bullet points for flexibility and easier editing; use numbered lists only when explicit ordering or referencing is required.
• Mermaid diagrams by default: Use Mermaid syntax for sequence and other diagrams to keep diagrams source-controlled and editable.
• Semantic line breaks: Break lines at semantic boundaries around 80 characters (allowing up to 100) with exceptions for tables and skill frontmatter, improving raw-source readability.
• Use Case: Ideal for README files, technical guides, and collaborative documentation where clean diffs and editor readability matter.

Quick Start

Apply the writing-style-markdown rules to the project's README to convert numbered lists to bullets where possible, add Mermaid diagrams for visual flows, and rewrap paragraphs to semantic line breaks around 80 characters.