markdown-quality

Validate Markdown edits with markdownlint until all linting errors are resolved.

12|1|Updated Jun 4, 2013
One-click install
npx skills add https://github.com/bostonaholic/dotfiles --skill markdown-quality-bostonaholic
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-quality
Source: https://github.com/bostonaholic/dotfiles/tree/main/claude/skills/markdown-quality
Command: npx skills add https://github.com/bostonaholic/dotfiles --skill markdown-quality-bostonaholic

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Every markdown file edit requires markdownlint validation. No exceptions for 'simple' changes.

Core Features & Use Cases

  • Markdownlint validation after every edit to enforce consistent formatting and eliminate linting violations.
  • Iterative corrections until all linting errors are resolved.
  • Use case: maintain documentation quality across a repository where multiple authors contribute Markdown files.

Quick Start

Run markdownlint on the edited file and iterate until it passes.

Frequently Asked Questions about markdown-quality

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically validate Markdown formatting after every edit?

To automatically validate Markdown formatting after every edit, you need a tool that runs markdownlint iteratively until all linting errors are resolved. This enforces consistent formatting across your documentation with zero violations.

What is markdownlint validation used for in documentation projects?

Markdownlint validation is used to enforce consistent formatting and eliminate linting violations across documentation repositories. It guarantees that every Markdown file edit meets quality standards, regardless of how simple the change is.

Do I need markdownlint installed to enforce Markdown quality checks?

Yes, you need markdownlint installed as a dependency. The validation process requires markdownlint to run after every Markdown edit and iterate until the file passes all linting rules.

Can I use automated Markdown linting for a repository with multiple authors?

Yes, you can use automated Markdown linting to maintain documentation quality across a repository where multiple authors contribute. It iteratively corrects formatting errors to ensure everyone's edits pass the same validation rules.

What is the best way to ensure zero Markdown linting violations in docs?

The best way to ensure zero Markdown linting violations is to enforce an iron law that runs markdownlint after every edit. This iterative process automatically corrects errors until all formatting issues are resolved.