engineering-handbook/.markdownlint-cli2.jsonc
Adam Moussa 9c65fcb053
Some checks failed
ci / ci / ci (push) Has been cancelled
ci: add markdown-lint and link-check CI (INFRA-128) (#16)
Add a standalone ci workflow so handbook changes get an automated gate.
The job is named literally "ci / ci" to emit the exact status context the
org main-branch-protection ruleset requires.

- markdownlint-cli2 (.markdownlint-cli2.jsonc): MD013/MD060/MD040 relaxed
  as noisy docs-style rules; fixed 3 MD032 blank-line-around-list issues.
- lychee link check (lychee.toml): internal + external links, tolerates 429.
2026-07-08 16:20:28 -04:00

23 lines
887 B
JSON

{
// 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"]
}