Author high-quality Markdown documentation with deterministic structure, lint compliance, and CI integration. Use when writing README files, creating docs pages, fixing markdownlint failures, defining style rules, or wiring markdown checks into pre-commit and pipelines. Keywords: markdown, markdownlint, readme, docs, headings, lists, code fences, links, images, lint config, ci, documentation style.
95
92%
Does it follow best practices?
Impact
97%
1.00xAverage score across 7 eval scenarios
Passed
No findings from the security scan
A team uses a GitHub repository with Markdown documentation across multiple directories. There are currently no automated checks for documentation quality.
Set up a GitHub Actions CI workflow that runs markdownlint-cli2 on every pull request
and push to main. The workflow must:
markdownlint-cli2 across all **/*.md files, excluding node_modules/..markdownlint.json that:
MD013 (line length) to 120 characters, excluding code blocks and tables.MD033 (inline HTML) to allow details, summary, br, and img.MD024 (no-duplicate-heading) to siblings_only: true.lint:md script in package.json that runs the linter.Produce two files:
.github/workflows/markdown-lint.yml — the CI workflowpackage.json — the root package.json with the lint script (only the relevant fields)