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
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.
1. Header with Badges
# Project Name
[](LICENSE)
[](releases)
[](builds)
Brief one-line description of what the project does.
2. Table of Contents (for longer READMEs)
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Contributing](#contributing)
- [License](#license)
3. Features Section
## Features
- **Feature 1**: Clear description with benefits
- **Feature 2**: What problems it solves
- **Feature 3**: Unique selling points
- Cross-platform support (Windows, macOS, Linux)
- Comprehensive test coverage (>90%)
4. Installation Instructions
## Installation
### Prerequisites
- Python 3.8 or higher
- pip package manager
### Quick Start
```bash
pip install package-name
git clone https://github.com/username/repo.git
cd repo
pip install -e .
**5. Usage Examples**
```markdown
## Usage
### Basic Example
```python
from package import Module
# Initialize
client = Module(api_key="your-key")
# Perform operation
result = client.process(data)
print(result)
See examples/ directory for more detailed use cases.
**6. API Documentation**
```markdown
## API Reference
### `Module.process(data, options=None)`
Process input data with optional configuration.
**Parameters:**
- `data` (str|dict): Input data to process
- `options` (dict, optional): Configuration options
- `verbose` (bool): Enable verbose output (default: False)
- `format` (str): Output format - 'json', 'yaml', 'xml' (default: 'json')
**Returns:**
- `dict`: Processed results with metadata
**Raises:**
- `ValueError`: If data is invalid
- `APIError`: If API request fails
**Example:**
```python
result = client.process(
data={"key": "value"},
options={"verbose": True, "format": "json"}
)
**7. Contributing Section**
```markdown
## Contributing
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
### Quick Contribution Guide
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
8. License and Credits
## License
This project is licensed under the MIT License - see [LICENSE](LICENSE) file for details.
## Acknowledgments
- Thanks to [Contributor Name] for feature X
- Inspired by [Project Name](link)
- Built with [Technology Stack]
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- New feature description
### Changed
- Modification to existing feature
### Deprecated
- Features that will be removed
### Removed
- Deleted features
### Fixed
- Bug fixes
### Security
- Security improvements
## [1.2.0] - 2025-01-15
### Added
- User authentication system (#123)
- Export to CSV functionality (#145)
- Dark mode support (#156)
### Changed
- Updated UI components for better responsiveness (#134)
- Improved error messages (#142)
### Fixed
- Fixed memory leak in background processor (#139)
- Resolved login timeout issue (#148)
## [1.1.0] - 2024-12-01
### Added
- Initial release with core features
```python
def hello_world():
"""Print hello world message."""
print("Hello, World!")
function helloWorld() {
console.log("Hello, World!");
}
# Install dependencies
npm install
# Run tests
npm test
### Tables
```markdown
| Feature | Description | Status |
|---------|-------------|--------|
| Auth | User authentication | ✅ Complete |
| API | RESTful API endpoints | ✅ Complete |
| Docs | Documentation | 🚧 In Progress |
| Tests | Unit & Integration | ❌ Planned |
<details>
<summary>Click to expand advanced configuration</summary>
## Advanced Options
Configure advanced settings:
```yaml