Markdown Linter for Openclaw

An automated utility for validating Markdown file structure, link integrity, and formatting consistency across documentation projects.

derick001
v1.0.0
Mar 11, 2026
0
1k
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install markdown-linter-cli

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install markdown-linter-cli 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 Linter?

Markdown Linter is a specialized tool within the Openclaw Skills ecosystem designed to enforce high standards for technical documentation. It functions as a comprehensive auditor that scans Markdown files for common structural errors, such as skipped header levels or missing image alt text, which can negatively impact both accessibility and SEO. By leveraging this tool, developers can maintain a consistent professional style across large repositories without manual oversight.

Built to integrate seamlessly into developer workflows, this skill helps teams identify and remediate formatting inconsistencies early in the content lifecycle. Whether you are managing a simple README or a complex multi-page documentation site, utilizing Markdown Linter within Openclaw Skills ensures your content is robust, readable, and free of broken internal or external references.

Markdown Linter Use Cases

  • Validating header hierarchies to ensure proper document nesting and navigation.
  • Auditing accessibility compliance by flagging images missing descriptive alt text.
  • Verifying the health of internal and external hyperlinks to prevent dead ends for readers.
  • Enforcing style consistency for list markers and line lengths across collaborative projects.
  • Cleaning up source code by detecting and removing unnecessary trailing whitespace.

How Markdown Linter Works

  1. The user triggers the Openclaw Skills command pointing to specific Markdown files or directories using glob patterns.
  2. The engine parses the Markdown source into a structured format, identifying elements like headers, links, and code blocks.
  3. The tool executes a suite of validation rules (MD001-MD010) to check for formatting and structural violations.
  4. If enabled, the skill performs network requests to verify the status codes of external URLs found in the text.
  5. A detailed JSON report is generated, mapping every issue to a specific line and column with a recommended fix.

Markdown Linter Setup

To utilize this skill in your environment, ensure Python 3 and the required dependencies are available. Follow these steps to configure Markdown Linter for Openclaw Skills:

# Install the necessary Python libraries
pip install markdown requests

# Run the linter on a specific file
./scripts/main.py run --input README.md

# Run with external link checking enabled
./scripts/main.py run --input docs/*.md --check-external-links

Markdown Linter Data Schema & Taxonomy

The skill generates structured audit data to facilitate automated quality gates. The schema focuses on identifying the exact location and nature of every documentation flaw found during the Openclaw Skills execution.

Attribute Description
file The relative path to the Markdown file analyzed
line/column The precise coordinate of the formatting issue
rule The specific rule ID (e.g., MD001) triggered by the content
severity The impact level of the issue, typically warning or error
message A human-readable description of the violation
fix A suggested string or action to resolve the issue

Markdown Linter Advanced Features

  • Support for glob patterns allows for recursive linting of nested documentation folders within Openclaw Skills.
  • Custom line-length thresholds to match internal corporate or project-specific style guides.
  • Selective rule ignoring via CLI flags to bypass specific linting constraints during transition periods.
  • Integrated external link validation to ensure all third-party references remain active and accurate.
  • Machine-readable JSON output designed for integration into CI/CD pipelines and automated reporting tools.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*