Markdown-Formatter - Beautify Your Markdown

Vernox Utility Skill - Make your markdown look professional.

Overview

Markdown-Formatter is a powerful tool for formatting, linting, and beautifying markdown documents. Supports multiple style guides (CommonMark, GitHub Flavored Markdown, custom rules) and handles everything from simple cleanup to complex reformatting.

Features

✅ Formatter Engine

• - Multiple style guides (CommonMark, GitHub, custom)
• Preserves document structure
• Handles nested lists, code blocks, tables
• Configurable line width and indentation
• Smart heading normalization
• Link reference optimization

✅ Linting & Cleanup

• - Remove trailing whitespace
• Normalize line endings (LF vs CRLF)
• Fix inconsistent list markers
• Remove empty lines at end
• Fix multiple consecutive blank lines

✅ Beautification

• - Improve heading hierarchy
• Optimize list formatting
• Format code blocks with proper spacing
• Wrap long lines at configured width
• Add proper spacing around emphasis

✅ Validation

• - Check markdown syntax validity
• Report linting errors
• Suggest improvements
• Validate links and references

Installation

CODEBLOCK0

Quick Start

Format a Document

CODEBLOCK1

Beautify Multiple Files

CODEBLOCK2

Lint and Fix

CODEBLOCK3

Tool Functions

formatMarkdown

Parameters:

• - markdown (string, required): Markdown content to format
• INLINECODE2 (string, required): Style guide name ('commonmark', 'github', 'commonmark', 'custom')
• INLINECODE3 (object, optional):

Returns:

• - formattedMarkdown (string): Formatted markdown
• INLINECODE15 (array): Array of warning messages
• INLINECODE16 (object): Formatting statistics
• INLINECODE17 (object): Linting errors and fixes
• INLINECODE18 (number): Original character count
• INLINECODE19 (number): Formatted character count

formatBatch

Parameters:

• - markdownFiles (array, required): Array of file paths
• INLINECODE22 (string): Style guide name
• INLINECODE23 (object, optional): Same as formatMarkdown options

Returns:

• - results (array): Array of formatting results
• INLINECODE25 (number): Number of files processed
• INLINECODE26 (number): Total warnings across all files
• INLINECODE27 (number): Time taken in ms

lintMarkdown

Parameters:

• - markdown (string, required): Markdown content to lint
• INLINECODE30 (string): Style guide name
• INLINECODE31 (object, optional): Additional linting options

Returns:

• - errors (array): Array of error objects
• INLINECODE37 (array): Array of warning objects
• INLINECODE38 (object): Linting statistics
• INLINECODE39 (array): Suggested fixes

Style Guides

CommonMark (default)

• - Standard CommonMark specification
• ATX headings (ATX-style)
• Reference-style links [text]
• Underscore emphasis
• Asterisk emphasis

GitHub Flavored Markdown

• - Fenced code blocks with \\\ - Tables with pipes - Task lists [ ] with x - Strikethrough ~~text~~ - Autolinks with <https://url> ### Consistent (default) - Consistent ATX heading levels - Consistent list markers - Consistent emphasis style - Consistent code block style ### Custom - User-defined rules - Regex-based transformations - Custom heading styles ## Use Cases ### Documentation Cleanup - Fix inconsistent formatting in README files - Normalize heading styles - Fix list markers - Clean up extra whitespace ### Content Creation - Format articles with consistent style - Beautify blog posts before publishing - Ensure consistent heading hierarchy ### Technical Writing - Format code documentation - Beautify API specs - Clean up messy markdown from LLMs ### README Generation - Format and beautify project README files - Ensure consistent structure - Professional appearance for open source ### Markdown Conversion - Convert HTML to markdown - Reformat from one style to another - Extract and format markdown from other formats ## Configuration ### Edit config.json`:

Examples

Simple Formatting

Complex Beautification

Linting and Fixing

Batch Processing

Performance

Speed

• - Small documents (<1000 words): <50ms
• Medium documents (1000-5000 words): 50-200ms
• Large documents (5000+ words): 200-500ms

Accuracy

• - Structure preservation: 100%
• Style guide compliance: 95%+
• Whitespace normalization: 100%

Error Handling

Invalid Input

• - Clear error message
• Suggest checking file path
• Validate markdown content before formatting

Markdown Parsing Errors

• - Report parsing issues clearly
• Suggest manual fixes
• Graceful degradation on errors

File I/O Errors

• - Clear error with file path
• Check file existence
• Suggest permissions fix
• Batch processing continues on errors

Troubleshooting

Format Not Applied

• - Check if style is correct
• Verify options are respected
• Check for conflicting rules
• Test with simple example

Linting Shows Too Many Errors

• - Some errors are style choices, not real issues
• Consider disabling specific checks
• Use custom rules for specific needs

Tips

Best Results

• - Use consistent style guide
• Enable fixLists, normalizeSpacing options
• Set maxWidth appropriate for your output medium
• Test on small samples first

Performance Optimization

• - Process large files in batches
• Disable unused linting checks
• Use simpler rules for common patterns

License

MIT