markdown-documentation

Name: markdown-documentation
Author: aj-geddes

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

INSTALLATION

npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill markdown-documentation

Run in your project or agent environment. Adjust flags if your CLI version differs.

SKILL.md

Markdown Documentation

[Overview](#overview)

[When to Use](#when-to-use)

[Quick Start](#quick-start)

[Reference Guides](#reference-guides)

[Best Practices](#best-practices)

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:

Guide

Contents

Text Formatting

Lists

Links and Images

Links and Images, Code Blocks, Tables

Extended Syntax (GitHub Flavored Markdown)

Collapsible Sections

Collapsible Sections, Syntax Highlighting, Badges

Alerts and Callouts

Mermaid Diagrams

Best Practices

✅ DO

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

❌ DON'T

Use "click here" as link text

Forget alt text on images

Mix HTML and Markdown unnecessarily

Use absolute paths for local files

Create walls of text without breaks

Skip language specification in code blocks

Use images for text content (accessibility)

markdown-documentation

SKILL.md

Markdown Documentation

Table of Contents

Overview

When to Use

Quick Start

Reference Guides

Best Practices

✅ DO

❌ DON'T

Stop writing automation&scrapers

markdown-documentation

SKILL.md

Markdown Documentation

Table of Contents

Overview

When to Use

Quick Start

Reference Guides

Best Practices

✅ DO

❌ DON'T

Let your agent run on any real-world website

Related skills

Stop writing automation&scrapers