PaperclipOrg
Claude Agent Skill · by Aj Geddes

Markdown Documentation

Install Markdown Documentation skill for Claude Code from aj-geddes/useful-ai-prompts.

Install
Terminal · npx
$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill markdown-documentation
Works with Paperclip

How Markdown Documentation fits into a Paperclip company.

Markdown Documentation drops into any Paperclip agent that handles this kind of work. Assign it to a specialist inside a pre-configured PaperclipOrg company and the skill becomes available on every heartbeat — no prompt engineering, no tool wiring.

S
SaaS FactoryPaired

Pre-configured AI company — 18 agents, 18 skills, one-time purchase.

$27$59
Explore pack
Source file
SKILL.md92 lines
Expand
---name: markdown-documentationdescription: >  Master markdown formatting, GitHub Flavored Markdown, README files, and  documentation formatting. Use when writing markdown docs, READMEs, or  formatting documentation.--- # Markdown Documentation ## Table of Contents - [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 ```markdown# 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](references/text-formatting.md) | Text Formatting || [Lists](references/lists.md) | Lists || [Links and Images](references/links-and-images.md) | Links and Images, Code Blocks, Tables || [Extended Syntax (GitHub Flavored Markdown)](references/extended-syntax-github-flavored-markdown.md) | Extended Syntax (GitHub Flavored Markdown) || [Collapsible Sections](references/collapsible-sections.md) | Collapsible Sections, Syntax Highlighting, Badges || [Alerts and Callouts](references/alerts-and-callouts.md) | Alerts and Callouts || [Mermaid Diagrams](references/mermaid-diagrams.md) | 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)