github-markdown

What problem does it solve?

Provides clear conventions and practical guidance to ensure Markdown renders as intended on GitHub, avoiding common pitfalls like broken tables, unrendered diagrams, incorrect relative links, and inaccessible images.

Core Features & Use Cases

• Standard guidance for task lists, nested checkboxes, and completion tracking in issues and PRs.
• Callout and alert patterns, collapsible sections for long logs, and recommendations for readable tables and code blocks with language tags.
• Best practices for mermaid diagrams, relative links, image alt text, HTML usage limits, emoji use, footnotes, and anti-patterns to avoid when authoring READMEs, docs, issues, and wiki pages.

Quick Start

Format the repository README using GitHub Flavored Markdown conventions: add task lists where actionable items belong, use collapsible sections for long output, add language-tagged code blocks and simple mermaid diagrams so content renders cleanly on GitHub.