markdown-documentation
Installation
Summary
Comprehensive reference for markdown syntax, GitHub Flavored Markdown, and documentation best practices.
- 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
SKILL.md
Markdown Documentation
Table of Contents
Overview
Master markdown syntax and best practices for creating well-formatted, readable documentation using standard Markdown and GitHub Flavored Markdown (GFM).
When to Use
- README files
- Documentation pages
- GitHub/GitLab wikis
Related skills