markdown-prolisted

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
aiskillstore/marketplace · ★ 329 · Data & Documents · score 79

Install: claude install-skill aiskillstore/marketplace

# 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** ```markdown # Project Name [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](releases) [![Build](https://img.shields.io/badge/build-passing-brightgreen.svg)](builds) Brief one-line description of what the project does. ``` **2. Table of Contents** (for longer READMEs) ```markdown ## Table of Contents - [Features](#features) - [Installation](#installation) - [Usage](#usage) - [API Reference](#api-reference) - [Contributing](#contributing) - [License](#lice