Introduction

eslint-plugin-markdown-links is an ESLint plugin that provides rules for checking the validity of links and URLs in Markdown files. It helps you:

• Detect and report dead or unreachable URLs in Markdown documents
• Customize rule behavior via flexible configuration

This plugin is designed to work alongside @eslint/markdown and is especially useful for documentation, wikis, and codebases that rely on Markdown files.

📛 Features

• Reports dead or unreachable external URLs in Markdown files
• Supports flexible configuration for rule behavior
• Integrates with ESLint and works alongside @eslint/markdown
• Provides recommended config for easy setup

Try it live: Check out the Online Demo to see the plugin in action!

📖 Usage

See User Guide.

✅ Rules

See Available Rules.

👫 Related Packages

• eslint-plugin-markdown-preferences ... ESLint plugin that enforces our markdown preferences.

🍻 Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools

• npm test runs tests and measures coverage.
• npm run update runs in order to update readme and recommended configuration.

🔒 License

See the LICENSE file for license rights and limitations (MIT).