When should I use the md-lint skill?

It is best practice to use this skill every time you finish writing or updating Markdown files intended for human readers to ensure maximum clarity and professional presentation.

What tools does the md-lint skill use?

The skill uses Prettier to handle aesthetic formatting and layout, and markdownlint-cli2 to enforce structural rules and syntax standards.

Can it fix all Markdown errors automatically?

It uses auto-fix for the majority of rules; however, for complex issues that cannot be automated (like rule MD060), it will prompt you to make manual corrections.

Can I run it on the entire repository at once?

Yes, if no specific file arguments are provided, the skill identifies the project root and processes every Markdown file in the repository.

Does it respect my existing project configurations?

Yes, it specifically looks for ~/.prettierrc and ~/.config/markdownlint/.markdownlint-cli2.jsonc to ensure it follows your defined styling rules.

Markdown Lint & Format

Name: Markdown Lint & Format
Author: jimweller

byjimweller

0•

Content Management

Standardizes and repairs Markdown documentation using Prettier and markdownlint-cli2 to ensure professional formatting and syntax compliance.

The md-lint skill automates the process of maintaining high-quality Markdown files within your repository by integrating Prettier for layout and markdownlint-cli2 for structural integrity. It is designed to be invoked after creating or editing documentation, providing a seamless workflow that identifies syntax errors, fixes common stylistic issues automatically, and prompts for manual intervention when complex violations occur. This ensures that all project documentation remains consistent, readable, and ready for version control without manual effort.

Key Features

01Advanced structural linting with markdownlint-cli2

02Intelligent handling of non-auto-fixable rules with user prompts

03Support for repository-wide cleanup or targeted file fixes

04Automated Markdown formatting via Prettier integration

05Custom configuration support via .prettierrc and .markdownlint-cli2.jsonc

060 GitHub stars

Use Cases

01Standardizing project documentation before merging pull requests

02Cleaning up auto-generated Markdown files to meet human-readable standards

03Enforcing consistent documentation styles across multi-contributor repositories

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jimweller/davit-dataops-dotfiles md-lint

For use in Claude.ai and ChatGPT

Key Features

01Advanced structural linting with markdownlint-cli2

02Intelligent handling of non-auto-fixable rules with user prompts

03Support for repository-wide cleanup or targeted file fixes

04Automated Markdown formatting via Prettier integration

05Custom configuration support via .prettierrc and .markdownlint-cli2.jsonc

060 GitHub stars

Use Cases

01Standardizing project documentation before merging pull requests

02Cleaning up auto-generated Markdown files to meet human-readable standards

03Enforcing consistent documentation styles across multi-contributor repositories

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jimweller/davit-dataops-dotfiles md-lint

For use in Claude.ai and ChatGPT