markdown

Lint, format, and validate links in Markdown documents.

3|Updated Jul 13, 2020

Search Tags:#linting #documentation #markdown #formatting #markdownlint #link-check #markdownfmt

Ready to run

npx skills add https://github.com/nieomylnieja/dotfiles --skill markdown-nieomylnieja

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown
Source: https://github.com/nieomylnieja/dotfiles/tree/main/config/agents/skills/markdown
Command: npx skills add https://github.com/nieomylnieja/dotfiles --skill markdown-nieomylnieja

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps teams maintain consistent, high-quality Markdown documentation by automating linting, formatting, and link validation across files like README.md and SKILL.md.

Core Features & Use Cases

Lint Markdown with markdownlint to enforce style and correctness across a repository.
Auto-format Markdown with markdownfmt to ensure consistent wrapping and structure.
Validate links with markdown-link-check to catch broken references in docs. Use case: keep documentation clean and navigable as projects evolve.

Quick Start

Run the Markdown skill on your target Markdown files to lint, format, and verify links.

Frequently Asked Questions about markdown

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

FAQPage Schema

How do I lint and format Markdown files like README.md automatically?▼

To validate Markdown links and catch broken references, you can use markdown-link-check. It scans your Markdown documents to ensure all URLs and references are navigable, keeping documentation clean and accessible as projects evolve.

What is the best way to maintain consistent Markdown documentation across a repository?▼

The best way to maintain consistent Markdown documentation is to automate quality checks using markdownlint, markdownfmt, and markdown-link-check. This combination enforces style rules, auto-formats structure, and validates links across all Markdown files.

Can I check for broken links in Markdown documentation?▼

Yes, you can check for broken links in Markdown documentation by using markdown-link-check. It validates links to catch broken references, ensuring your README.md and other documentation files remain navigable and error-free.

Does markdownlint work for reviewing SKILL.md files in documentation projects?▼

Yes, markdownlint works for reviewing SKILL.md files in documentation projects. It enforces style and correctness across Markdown documents, making it suitable for drafting, updating, and reviewing documentation files within a repository.

Why does my Markdown formatting break when I update documentation?▼

Markdown formatting may break when updating documentation due to inconsistent wrapping or structural errors. Running markdownfmt auto-formats the structure, while markdownlint identifies style violations to prevent compatibility issues with Markdown tooling.