markdown-formatter

What This Skill Does

The markdown-formatter skill is a robust utility for OpenClaw users designed to standardize, clean, and beautify markdown documentation. Whether you are maintaining a technical project, drafting blog posts, or managing complex documentation files, this tool ensures that your markdown adheres to professional standards. It operates as a highly configurable engine that supports multiple style guides, including CommonMark and GitHub Flavored Markdown (GFM). Beyond simple aesthetic adjustments, it handles critical tasks like normalizing line endings, fixing inconsistent list markers, removing redundant whitespace, and verifying overall syntax validity. By automating the cleanup process, it allows developers and content creators to focus on the substance of their writing rather than the minutiae of formatting.

Installation

To integrate the markdown-formatter into your OpenClaw environment, ensure you have access to the package manager and execute the following command in your terminal:

clawhub install markdown-formatter

Once installed, the tool becomes immediately available to your agent workflows, providing programmatic access to the formatMarkdown, formatBatch, and lintMarkdown functions.

Use Cases

1. Standardizing Documentation: Apply a consistent style guide across large repositories to ensure all documentation files share a uniform look and feel.
2. Cleanup for CI/CD Pipelines: Integrate the formatter into automated build processes to catch syntax errors or poor formatting before documentation is published to live sites.
3. Content Migration: Use the tool to sanitize messy markdown exports from other platforms, ensuring the content is clean and compliant with current project standards.
4. Batch Beautification: Quickly process hundreds of README files or technical guides simultaneously to maintain high quality across an entire codebase.

Example Prompts

1. "Format the file at ./docs/api-reference.md using GitHub Flavored Markdown style and set the max line width to 100 characters."
2. "Please lint the following markdown string for syntax errors and suggest improvements for the list structure: [INSERT_MARKDOWN_HERE]."
3. "Run a batch format on all .md files in the current directory and report back any persistent warnings or linting errors found."

Tips & Limitations

• Tip: Always back up your files before running batch operations if you are working on a critical codebase, as reformatting can drastically change the physical file structure.
• Tip: Use the 'custom' style option if your team has specific requirements regarding header depths or table layouts that standard guides do not support.
• Limitation: While the tool is excellent at formatting, it cannot rewrite prose or correct grammatical errors; it is strictly a syntactical and structural assistant.
• Limitation: Ensure your environment has sufficient read/write permissions for the target directories, as the formatter will attempt to overwrite the original files during fix operations.