A technical validation skill for auditing Markdown files to ensure link consistency and structural syntax compliance.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install markdown-linter
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-linter 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?
The Markdown Linter is a lightweight utility designed to maintain the integrity of documentation workspaces. It specializes in detecting broken internal file links, verifying header hierarchies, and ensuring that code blocks are properly tagged. When building or maintaining Openclaw Skills, this tool acts as a quality assurance layer that prevents broken references in critical files like MEMORY.md or SKILL.md, ensuring that both human readers and AI agents can navigate the project successfully.
This skill is particularly valuable for large-scale projects where documentation is updated frequently. By automating the verification process, it eliminates the manual overhead of clicking through links to verify they point to existing assets, thus streamlining the development lifecycle.
Markdown Linter Use Cases
- Verifying that all relative file links in a repository point to valid existing files.
- Auditing documentation for logical header nesting to ensure an H2 follows an H1.
- Checking that all code snippets have assigned language identifiers for proper syntax highlighting.
- Maintaining structural consistency in Openclaw Skills metadata to prevent agent confusion.
How Markdown Linter Works
- The skill initiates a recursive scan of the specified directory to identify all Markdown (.md) files.
- It parses each file to extract internal links, image references, and structural elements like headers and code blocks.
- The tool performs a file system check for every relative link to confirm the destination exists.
- It evaluates the Markdown syntax against common standards for hierarchy and metadata.
- A comprehensive JSON report is generated, detailing any broken links or syntax warnings by file and line number.
Markdown Linter Setup
To use the Markdown Linter, ensure you have the source files in your workspace and execute it via Node.js:
# Navigate to your workspace directory
cd your-project-folder
# Run the linter using a script or direct Node execution
node -e "const linter = require('./index'); linter.scan('.').then(results => console.log(JSON.stringify(results, null, 2)))"
Markdown Linter Data Schema & Taxonomy
The skill provides output in a structured JSON format to allow for easy integration with other tools:
| Property | Description |
|---|---|
| totalFiles | The count of Markdown files analyzed during the scan. |
| brokenLinks | An array of objects containing the file path, line number, and the invalid link. |
| syntaxErrors | An array of identified structural issues, such as invalid header levels. |
Markdown Linter Advanced Features
- Recursive directory analysis for complex documentation architectures.
- Automated detection of missing file references across Openclaw Skills project structures.
- Integration-ready JSON output for use in automated CI/CD documentation checks.
- High-performance link validation for large-scale technical repositories.
SKILL.md
Loading
Related Openclaw Skills
json-repair-kit
A specialized Node.js utility designed to automatically repair and normalize malformed or loose JSON syntax into valid standards.
JSON Modifier
A specialized utility for applying RFC 6902 compliant JSON patches to files safely without rewriting the entire document.
JSON Linter
A lightweight utility for recursively scanning workspaces to identify and report syntax errors in JSON files.
HLE Reasoning Wrapper
A specialized tool for wrapping Humanity's Last Exam (HLE) questions in a structured Chain-of-Thought reasoning framework.
Markdown Validator
A high-performance CLI tool designed to identify broken internal links and maintain documentation integrity within Markdown files.
Signup Lead for AgenticCreed
Automates the creation of signup leads in the AgenticCreed system via a secure public HTTP endpoint.
Featured*
