fatby/markdown-formatter

--- name: markdown-formatter description: Format and beautify markdown documents with configurable styles. Preserve structure, fix formatting, ensure consistency. metadata: { "openclaw": { "version": "1.0.0", "author": "Vernox", "license": "MIT", "tags": ["markdown", "formatter", "beautifier", "text", "formatting", "documentation"], "category": "tools" } } --- # 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 bash clawhub install markdown-formatter ## Quick Start ### Format a Document javascript const result = await formatMarkdown({ markdown: '# My Document\n\n\n## Section 1\nContent here...', style: 'github', options: { maxWidth: 80, headingStyle: 'atx' } }); console.log(result.formattedMarkdown); ### Beautify Multiple Files javascript const results = await formatBatch({ markdownFiles: ['./doc1.md', './doc2.md', './README.md'], style: 'github', options: { wrapWidth: 80 } }); results.forEach(result => { console.log(`${result.file}: ${result.warnings} warnings`); }); ### Lint and Fix javascript const result = await lintMarkdown({ markdown: '# My Document\n\n\nBad list\n\n- item 1\n- item 2', style: 'github' }); console.log(`Errors found: ${result.errors}`); console.log(`Fixed: ${result.fixed}`); ## Tool Functions ### formatMarkdown Format markdown content according to style guide. Parameters: - markdown (string, required): Markdown content to format - style (string, required): Style guide name ('commonmark', 'github', 'commonmark', 'custom') - options (object, optional): - maxWidth (number): Line wrap width (default: 80) - headingStyle (string): 'atx' | 'setext' | 'underlined' | 'consistent' (default: 'atx') - listStyle (string): 'consistent' | 'dash' | 'asterisk' | 'plus' (default: 'consistent') - codeStyle (string): 'fenced' | 'indented' (default: 'fenced') - emphasisStyle (string): 'underscore' | 'asterisk' (default: 'asterisk') - strongStyle (string): 'asterisk' | 'underline' (default: 'asterisk') - linkStyle (string): 'inline' | 'reference' | 'full' (default: 'inline') - preserveHtml (boolean): Keep HTML as-is (default: false) - fixLists (boolean): Fix inconsistent list markers (default: true) - normalizeSpacing (boolean): Fix spacing around formatting (default: true) Returns: - formattedMarkdown (string): Formatted markdown - warnings (array): Array of warning messages - stats (object): Formatting statistics - lintResult (object): Linting errors and fixes - originalLength (number): Original character count - formattedLength (number): Formatted character count ### formatBatch Format multiple markdown files at once. Parameters: - markdownFiles (array, required): Array of file paths - style (string): Style guide name - options (object, optional): Same as formatMarkdown options Returns: - results (array): Array of formatting results - `tot