engineering-handbook/.markdownlint-cli2.jsonc

24 lines
887 B
JSON
Raw Permalink Normal View History

{
// markdownlint-cli2 config for the engineering handbook.
// Run locally with: npx --yes markdownlint-cli2 "**/*.md" "#node_modules"
// CI runs the same command (see .github/workflows/ci.yaml).
"config": {
"default": true,
// MD013 (line-length): disabled. The handbook is prose and wide reference
// tables; hard-wrapping at 80 columns hurts readability and diffs. Line
// length is not a correctness concern for docs.
"MD013": false,
// MD060 (table-column-style): disabled. Purely cosmetic pipe-padding style
// for compact tables; the existing tables are compact and render fine.
"MD060": false,
// MD040 (fenced-code-language): disabled. Several fenced blocks are
// directory trees / plain-text output that have no meaningful language tag.
"MD040": false
},
"globs": ["**/*.md"],
"ignores": ["node_modules", ".git"]
}