markdown-writing-standards

What problem does it solve?

Prevents broken or misrendered Mermaid diagrams and inconsistent Markdown structure by enforcing a concise set of syntactic and stylistic rules so diagrams and tables render reliably across tools and avoid time-consuming fixes.

Core Features & Use Cases

• Mermaid safety rules: bans emoji, requires quoting for special characters, enforces node ID formats, controls <br/> usage, and provides per-diagram self-checklists to eliminate render errors.
• Structured Markdown guidance: enforces table, code block, and heading conventions to keep documentation consistent and machine-friendly.
• Use Case: validate design docs, bug-call chains, sequence/state/class diagrams, and project docs before committing or publishing to ensure compatibility across GitHub, GitLab, and editors.

Quick Start

Run the markdown-writing-standards check on your draft to validate Mermaid blocks, tables, and code blocks and fix any violations before saving the file.