Parent: #1
Summary
Add markdownlint-cli2 as a linter for all markdown files, runnable via npx with no committed dependencies.
Problem / Motivation
No automated way to catch formatting inconsistencies, broken heading hierarchy, trailing whitespace, or style drift across 13 markdown files (~2,200 lines).
Proposed Solution
Add markdownlint-cli2 with a project-specific configuration file, run via npx.
Implementation Details
- Create
.markdownlint-cli2.jsonc with rules tuned for this project:
- Disable
MD013 (line length) — SKILL.md files have long template lines
- Disable
MD033 (inline HTML) — README.md uses centered HTML headers
- Disable
MD041 (first-line heading) — SKILL.md files start with YAML frontmatter
- Enable all other default rules
- Add lint command to CLAUDE.md commands section:
npx markdownlint-cli2 "**/*.md"
- Update
docs/development.md to document the lint command
- Fix any existing lint violations found on first run
Alternatives Considered
- package.json with lint script — Adds dependency management to a prompt-only repo. Not worth it for a single tool.
- mdformat (Python) — Auto-formatter that may aggressively rewrite SKILL.md content. Less control over rules.
Acceptance Criteria
Parent: #1
Summary
Add markdownlint-cli2 as a linter for all markdown files, runnable via
npxwith no committed dependencies.Problem / Motivation
No automated way to catch formatting inconsistencies, broken heading hierarchy, trailing whitespace, or style drift across 13 markdown files (~2,200 lines).
Proposed Solution
Add markdownlint-cli2 with a project-specific configuration file, run via
npx.Implementation Details
.markdownlint-cli2.jsoncwith rules tuned for this project:MD013(line length) — SKILL.md files have long template linesMD033(inline HTML) — README.md uses centered HTML headersMD041(first-line heading) — SKILL.md files start with YAML frontmatternpx markdownlint-cli2 "**/*.md"docs/development.mdto document the lint commandAlternatives Considered
Acceptance Criteria
.markdownlint-cli2.jsonccreated with project-appropriate rulesnpx markdownlint-cli2 "**/*.md"runs cleanly with no violationsdocs/development.mdupdated