Does this skill support checking external links?

Yes, it includes guidance on creating asynchronous rules that can utilize Node.js modules like 'fs' or 'path' to validate relative file paths or external resources.

Can custom markdownlint rules automatically fix errors?

Yes, by providing a fixInfo object in the onError callback, you can define specific logic to delete, insert, or replace text, allowing the linter to repair files automatically.

What is the difference between markdown-it and micromark parsers?

markdown-it is ideal for high-level token-based parsing with rich metadata, while micromark offers more detailed token analysis and precise positioning for more granular rules.

What are the required properties for a custom rule object?

Every custom rule must include names, description, tags, parser (set to 'markdownit', 'micromark', or 'none'), and a function containing the validation logic.

How do I pass configuration to a custom rule?

Custom rules receive a 'params' object containing a 'config' property, which maps directly to settings defined for that rule in your .markdownlint.json file.

Markdownlint Custom Rule Architect

Name: Markdownlint Custom Rule Architect
Author: TheBushidoCollective

byTheBushidoCollective

•

Developer Tools

Enables the creation of bespoke markdownlint rules to enforce project-specific documentation standards and automated formatting fixes.

This skill provides a comprehensive framework for architecting custom markdownlint rules, allowing developers to extend standard linting capabilities with domain-specific logic. It covers the entire lifecycle of rule development, from defining the basic JavaScript object structure to implementing advanced features like markdown-it and micromark parser integration. Users can learn how to report detailed errors, provide precise range-based highlighting, and implement automated 'fixInfo' logic to resolve violations programmatically. Whether you are enforcing naming conventions, validating code block languages, or building asynchronous link checkers, this skill streamlines the process of maintaining high-quality, consistent documentation.

Key Features

0195 GitHub stars

02Asynchronous rule support for external API or filesystem-based validation

03Dual-parser support for token-based (markdown-it) and granular (micromark) analysis

04Standardized JavaScript rule object templates and property mapping

05Automated fix implementation using delete, insert, and replace logic

06Dynamic configuration integration via .markdownlint.json parameters

Use Cases

01Enforcing corporate branding and specific terminology across large documentation repositories

02Automating the migration or repair of legacy Markdown formatting patterns

03Implementing complex validation like broken relative link detection or code block metadata checks

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add thebushidocollective/han markdownlint-custom-rules

For use in Claude.ai and ChatGPT

Download Skill