Skip to content

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:

  1. Front matter
  2. Headings
  3. 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 docs
docs/guide.md:1:1: front-matter[missing] file does not start with a '---' front matter block
docs/setup.md:3:1: front-matter[invalid-yaml] unquoted value contains ': '; quote the value
2 problem(s) in 2 file(s)

The command:

mddocslint docs

The report:

docs/guide.md:1:1: front-matter[missing] file does not start with a '---' front matter block
docs/setup.md:3:1: front-matter[invalid-yaml] unquoted value contains ': '; quote the value

The summary line:

2 problem(s) in 2 file(s)