A comprehensive tool for formatting and linting markdown documents to ensure professional consistency across various style guides.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install markdown-formatter
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install markdown-formatter using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Markdown-Formatter?
Markdown-Formatter is a versatile utility designed to standardize markdown documentation through automated formatting and linting. It supports popular style guides such as CommonMark and GitHub Flavored Markdown (GFM), enabling developers to maintain a professional appearance across all text-based files. This tool is a vital addition to your library of Openclaw Skills, as it automates the tedious aspects of documentation maintenance, such as fixing inconsistent list markers and optimizing heading hierarchies.
Beyond simple beautification, the skill provides deep validation to check markdown syntax, report linting errors, and suggest improvements. Whether you are managing a single README or a massive documentation site, this skill ensures your content remains readable, consistent, and structured according to industry standards.
Markdown-Formatter Use Cases
- Standardizing README files and project documentation for open-source consistency.
- Cleaning up messy markdown generated by LLMs or external content sources.
- Automating technical writing workflows to ensure proper heading hierarchy and link optimization.
- Batch processing multiple documentation files to normalize line endings and whitespace.
- Converting and reformatting documents between different style guides like GFM and CommonMark.
How Markdown-Formatter Works
- The skill ingests raw markdown content or file paths via its core tool functions like formatMarkdown or formatBatch.
- It applies a selected style guide (CommonMark, GitHub, or Custom) to evaluate the existing document structure.
- The formatter engine normalizes headings, fixes inconsistent list markers, and optimizes code block spacing.
- A linting pass identifies syntax errors, broken links, or style inconsistencies based on the configured rules.
- The skill returns the beautified markdown along with detailed statistics, original/formatted length, and any remaining warnings.
Markdown-Formatter Setup
To get started with this component of Openclaw Skills, install the package via the CLI:
clawhub install markdown-formatter
Once installed, you can begin formatting documents immediately using the default configuration or by editing the config.json file to set your preferred defaultStyle and maxWidth.
Markdown-Formatter Data Schema & Taxonomy
The skill processes data using specific input parameters and returns a structured response object.
Input Parameters
| Parameter | Type | Description |
|---|---|---|
| markdown | string | The raw content to be formatted. |
| style | string | The target guide (e.g., 'github', 'commonmark'). |
| options | object | Config for maxWidth, headingStyle, listStyle, and codeStyle. |
Output Schema
formattedMarkdown: The final beautified string.warnings: An array of messages highlighting potential issues.stats: Object containing processing time and character count changes.lintResult: Detailed breakdown of fixed and remaining linting errors.
Markdown-Formatter Advanced Features
- Batch processing capabilities to handle entire directories of documentation simultaneously for high-efficiency workflows.
- Customizable regex-based transformation rules for specialized or proprietary formatting requirements.
- Intelligent link reference optimization and validation to prevent broken links in published documentation.
- Multi-style support including ATX and Setext heading normalization to match any project preference.
- Configurable line wrapping and indentation controls for optimized readability across different IDEs.
SKILL.md
Loading
Related Openclaw Skills
Landing Page Generator
An automated engine for generating high-converting, SEO-optimized landing pages using proven copywriting frameworks and responsive design.
File-Deduplicator
An intelligent file management utility for identifying and removing duplicate files through content hashing and customizable safety protocols.
Content Recycler
A powerful automation tool for transforming long-form articles into platform-optimized social media posts and multi-day content calendars.
AffiliateMaster
AffiliateMaster is a comprehensive automation suite for Openclaw Skills designed to handle link generation, revenue tracking, and FTC-compliant content integration.
Morning Briefing Generator
A high-performance AI agent skill that aggregates your schedule, tasks, weather, and urgent communications into a single, actionable morning report.
Newsletter Generator
An automated framework for curating high-quality content and generating affiliate-monetized email newsletters at scale.
Featured*
