markdown-documentation

Comprehensive reference for markdown syntax, GitHub Flavored Markdown, and documentation best practices. Master markdown syntax and best practices for creating well-formatted, readable documentation using standard Markdown and GitHub Flavored Markdown (GFM). Detailed implementations in the references/ directory: - Covers core markdown elements: headers, text formatting, lists, links, images, code blocks, and tables - Includes GitHub Flavored Markdown extensions: collapsible sections, syntax highlighting, badges, alerts, and Mermaid diagrams - Provides actionable best practices for README files, wikis, and technical documentation, including accessibility guidelines and link management - Organized as modular reference guides with clear do's and don'ts for common documentation scenarios - Overview - When to Use - Quick Start - Reference Guides - Best Practices - README files - Documentation pages - GitHub/GitLab wikis - Blog posts - Technical writing - Project documentation - Comment formatting - Comment formatting - Use descriptive link text - Include table of contents for long documents - Add alt text to images - Use code blocks with language specification - Keep lines under 80-100 characters - Use relative links for internal docs - Add badges for build status, coverage, etc. - Include examples and screenshots - Use semantic line breaks - Test all links regularly - Use "click...