
Markdown Documentation
This is your reference when you need to write or format markdown documentation and want to get the syntax right without tab-switching to Google. It covers standard markdown plus GitHub Flavored Markdown extensions like tables, task lists, and alerts. The skill breaks down text formatting, links, images, code blocks, and newer features like collapsible sections and Mermaid diagrams. Most useful when writing READMEs or technical docs and you can't remember if it's three backticks or four, or how to make that strikethrough work. The best practices section is solid, calling out common mistakes like skipping language specification in code blocks or using absolute paths for local files.
- skills.sh installs
- 1.3K
- GitHub stars
- 379
- last updated
- Aug 21, 2026
Install
$ npx -y skills add aj-geddes/useful-ai-prompts --skill markdown-documentation --agent claude-codeInstalls into .claude/skills of the current project.
Files
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
- Blog posts
- Technical writing
- Project documentation
- Comment formatting
Quick Start
- Comment formatting
# H1 Header
## H2 Header
### H3 Header
#### H4 Header
##### H5 Header
###### H6 Header
# Alternative H1
## Alternative H2
Reference Guides
Detailed implementations in the references/ directory:
Sponsors
Details
- Repository
- github.com/aj-geddes/useful-ai-prompts
- Categories
- Git & Pull Requests, Documentation, AI & Agent Building
More from aj-geddes/useful-ai-prompts
All 258- Terraform Infrastructure1.2K
- Responsive Web Design1.1K
- Penetration Testing1.1K
- Css Architecture969
- Api Contract Testing926
- Root Cause Analysis916
- Event Sourcing892
- Mobile First Design869
- Api Security Hardening868
- Mobile App Testing831
- Technical Specification811
- User Story Writing793
- Access Control Rbac763
- User Guide Creation762
- Kubernetes Deployment759
- Logging Best Practices742
- Visual Regression Testing731
- Flutter Development725
- E2e Testing Automation695
- Business Case Development683
- React Component Architecture683
- Docker Containerization681
- Agile Sprint Planning677
- Log Analysis674