forked from NVIDIA/OpenShell
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.markdownlint-cli2.jsonc
More file actions
33 lines (33 loc) · 1.05 KB
/
.markdownlint-cli2.jsonc
File metadata and controls
33 lines (33 loc) · 1.05 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
"globs": [
"**/*.md",
"**/*.mdx"
],
"gitignore": true,
"ignores": [
".agents/**",
".claude/**",
".opencode/**",
".github/**",
"THIRD-PARTY-NOTICES/**",
"CLAUDE.md"
],
"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" }
}
}