Files
OpenShell/.markdownlint-cli2.jsonc
T

49 lines
1.5 KiB
JSON

{
"globs": [
"*.md",
"architecture/**/*.md",
"crates/**/*.md",
"deploy/**/*.md",
"docs/**/*.md",
"docs/**/*.mdx",
"e2e/**/*.md",
"examples/**/*.md",
"rfc/**/*.md"
],
"gitignore": false,
"ignores": [
".agents/**",
".claude/**",
".opencode/**",
".github/**",
"architecture/plans/**",
"**/node_modules/**",
"target/**",
".pytest_cache/**",
"THIRD-PARTY-NOTICES/**",
"CLAUDE.md",
// Man page sources use pandoc markdown with multiple H1 sections
// (NAME, SYNOPSIS, DESCRIPTION, etc.) which is standard for man
// pages but violates MD025.
"deploy/man/**"
],
"config": {
"default": true,
// Allow long lines — prose paragraphs are single-line per project style.
"MD013": false,
// Allow GitHub-rendered HTML commonly used in READMEs (centered logos,
// collapsible sections, keyboard hints). Regular prose HTML still flagged.
"MD033": { "allowed_elements": ["p", "img", "br", "a", "div", "details", "summary", "kbd", "sub", "sup"] },
// Allow duplicate headings in different sections.
"MD024": { "siblings_only": true },
// Bare URLs are fine in changelogs and tables.
"MD034": false,
// Internal docs commonly use bare fences for diagrams and terminal sketches.
"MD040": false,
// First line does not need to be a heading.
"MD002": false,
// Repo uses padded table pipes (`| foo | bar |`); rule default is "compact".
"MD060": { "style": "padded" }
}
}