aj-geddes avatar

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-code

Installs 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
1smixs avatarcreative-directorsmixs/creative-director-skillAI creative director with recursive self-assessment. Generates concepts using world-class methodologies (SIT, TRIZ, Lateral Thinking, bisociation), scores again1.3Kskills.sh installs
2eyadsibai avatardocument-processingeyadsibai/ltkUse when working with "PDF", "Excel", "Word", "PowerPoint", "XLSX", "DOCX", "PPTX", "spreadsheets", "presentations", "extract text", "merge documents", "convert1.3Kskills.sh installs
3neolabhq avatarcreate-ruleneolabhq/context-engineering-kitUse when found gap or repetative issue, that produced by you or implemenataion agent. Esentially use it each time when you say "You absolutly right, I should ha1.3Kskills.sh installs
4wubing2023 avatarpaper-spinewubing2023/paperspineWrite, rewrite, or build a paper or report (journal, conference, report, review, competition) end to end, then output LaTeX/PDF/Word. The main PaperSpine entry 1.3Kskills.sh installs
5nexscope-ai avatarecommerce-email-marketing-buildernexscope-ai/ecommerce-skillsE-commerce email marketing system builder. Creates complete email automation flows with full copywriting, subject lines, ESP setup instructions, segmentation ru1.2Kskills.sh installs
6cap-go avatarcapacitor-app-storecap-go/capgo-skillsComplete guide to publishing Capacitor apps to Apple App Store and Google Play Store. Covers app preparation, screenshots, metadata, review guidelines, and subm1.2Kskills.sh installs