mddocslint
This is a simple Markdown docs linter, built end-to-end with Claude Code.
By running a command, it lints a Markdown (.md) file or a folder of Markdown files for three areas:
- Front matter
- Headings
- Broken links
If mddocslint finds a problem in any of these areas, it reports the file, the line and column where the problem occurs, the rule that was broken, and a summary line at the end.
mddocslint docsdocs/guide.md:1:1: front-matter[missing] file does not start with a '---' front matter blockdocs/setup.md:3:1: front-matter[invalid-yaml] unquoted value contains ': '; quote the value2 problem(s) in 2 file(s)The command:
mddocslint docsThe report:
docs/guide.md:1:1: front-matter[missing] file does not start with a '---' front matter blockdocs/setup.md:3:1: front-matter[invalid-yaml] unquoted value contains ': '; quote the valueThe summary line:
2 problem(s) in 2 file(s)Get started
Section titled “Get started”- Install mddocslint.
- Run it on a docs folder.
- See what each check reports in the rules reference.
- Learn how to read the output and exit codes.
- Set up the pre-commit hook.