Agent skill · writing content · aiskillstore
markdown-pro
Professional Markdown documentation skill for creating polished README files, changelogs, contribution guides, and technical documentation. Use for: (1) README generation with badges and sections, (2) Automated changelog from git history, (3) Table of contents generation, (4) Contribution guidelines, (5) Technical documentation formatting, (6) Code documentation with syntax highlighting
Why this skill is useful
Adds automated changelog generation and structured README templates that the AI wouldn't reliably generate on its own.
What it needs
About 5k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Professional Markdown Documentation Overview This skill provides comprehensive guidance for creating professional, well-structured Markdown documentation. It covers README files, changelogs, contribution guides, and technical documentation with modern formatting, badges, and best practices. Core Capabilities README Generation Project overview and description Installation instructions Usage examples with code blocks API documentation Badges and shields Feature highlights Screenshots and demos Changelog Automation Semantic versioning format Git history parsing Automated release notes Breaking changes highlighting Contributor attribution Technical Documentation Clear section hierarchy Code syntax highlighting API reference formatting Table of contents Cross-referencing Collapsible sections README Structure Best Practices Essential Sections 1. Header with Badges 2. Table of Contents (for longer READMEs) 3. Features Section 4. Installation Instructions bash pip install package-name bash git clone https://github.com/username/repo.git cd repo pip install -e . 5. Usage Examples python from package import Module Initialize client = Module(apikey="your-key") Perform operation result = client.process(data) print(result) 6. API Documentation python result = client.process( data={"key": "value"}, options={"verbose": True, "format": "json"} ) 7. Contributing Section 8. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/markdown-pro