Markdown Documentation

by aj-geddes3f5182cfd739No license355 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 7 months ago

Master markdown formatting, GitHub Flavored Markdown, README files, and documentation formatting. Use when writing markdown docs, READMEs, or formatting documentation.

Instructions onlyWriting & Content

AI-generated overview

Guides writing and formatting Markdown documentation, including GitHub Flavored Markdown, READMEs and technical docs.

What it does: Provides Markdown syntax guidance and best practices for producing well-formatted, readable documentation. It covers standard Markdown and GitHub Flavored Markdown, with reference guides on text formatting, lists, links and images, code blocks, tables, extended syntax, collapsible sections, alerts and callouts, and Mermaid diagrams. It also includes a document template and do/don't best practices for documentation quality and accessibility.
When to use it: Use it when writing or formatting Markdown documents such as README files, documentation pages, wikis, blog posts or technical writing. It is also suited to reviewing Markdown formatting conventions and accessibility practices in existing docs.
Requirements: No scripts or special tooling; it is instructions and reference documents only.

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

markdown

# H1 Header
## H2 Header
### H3 Header
#### H4 Header
##### H5 Header
###### H6 Header
# Alternative H1
## Alternative H2

# 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 [blocked]	Text Formatting
Lists [blocked]	Lists
Links and Images [blocked]	Links and Images, Code Blocks, Tables
Extended Syntax (GitHub Flavored Markdown) [blocked]	Extended Syntax (GitHub Flavored Markdown)
Collapsible Sections [blocked]	Collapsible Sections, Syntax Highlighting, Badges
Alerts and Callouts [blocked]	Alerts and Callouts
Mermaid Diagrams [blocked]	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)

Source and attribution

Source:aj-geddes/useful-ai-promptsinskills/markdown-documentationat commit3f5182c

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

Markdown Documentation

Markdown Documentation

Table of Contents

Overview

When to Use

Quick Start

Reference Guides

Best Practices

✅ DO

❌ DON'T

Source and attribution

More from aj-geddes/useful-ai-prompts

Xss Prevention

Wireframe Prototyping

Web Performance Optimization

Vue Application Structure

Visual Regression Testing

User Persona Creation

More in Writing & Content

Doc Coauthoring

Writing Guidelines

Job Post Builder

Write Spec

Draft Content

Brand Voice Enforcement