markdown-formatter
Format and structure content as clean, well-organized Markdown. Use when asked to create documentation, format text, or generate Markdown output.
When & Why to Use This Skill
The Markdown Formatter Claude skill is designed to automate the transformation of unstructured text into professional, well-organized Markdown documentation. It enhances content readability and SEO by enforcing a logical heading hierarchy, applying syntax highlighting to code blocks, and structuring complex data into clean tables and lists. This tool is essential for developers and writers who need to maintain consistent formatting standards across technical documents, README files, and blog posts.
Use Cases
- API Documentation: Convert raw function descriptions and parameter lists into structured, easy-to-read developer documentation with proper tables and code blocks.
- Content Restructuring: Transform messy meeting notes or brainstorming drafts into polished articles with clear H1-H3 hierarchies and nested lists.
- Technical Blogging: Standardize the formatting of technical tutorials to ensure code snippets are correctly highlighted and sections are logically separated for better user experience.
| name | markdown-formatter |
|---|---|
| description | Format and structure content as clean, well-organized Markdown. Use when asked to create documentation, format text, or generate Markdown output. |
| version | 1.0.0 |
Markdown Formatter
Overview
Transforms unstructured content into clean, well-organized Markdown with proper headings, lists, code blocks, and formatting.
Instructions
When formatting content to Markdown:
- Analyze the content to identify structure (headings, lists, code, etc.)
- Apply hierarchy using appropriate heading levels (H1 for title, H2 for sections)
- Format code with proper language-specific syntax highlighting
- Create lists for related items (bullet for unordered, numbers for sequential)
- Add tables for structured data comparisons
Formatting Rules
Headings
- H1 (
#) - Document title only - H2 (
##) - Major sections - H3 (
###) - Subsections - H4+ - Avoid unless necessary
Code Blocks
- Inline code: Single backticks for short references
- Fenced blocks: Triple backticks with language identifier
Lists
- Bullet lists: Related but unordered items
- Numbered lists: Sequential steps or ranked items
- Nested lists: Maximum 2 levels deep
Examples
Example: Format API Documentation
Input: "Document the getUser function that takes userId string and returns User object with name email and createdAt fields"
Output:
## `getUser(userId)`
Retrieves a user by their unique identifier.
### Parameters
| Name | Type | Description |
|------|------|-------------|
| `userId` | `string` | The unique user identifier |
### Returns
`User` object with the following properties:
- `name` - User's display name
- `email` - User's email address
- `createdAt` - Account creation timestamp
Guidelines
- Keep line length under 100 characters
- Use blank lines to separate sections
- Prefer ATX-style headings (
#) over Setext - Use reference-style links for repeated URLs