-
Notifications
You must be signed in to change notification settings - Fork 346
Expand file tree
/
Copy path.markdownlint-cli2.jsonc
More file actions
47 lines (41 loc) · 1.79 KB
/
Copy path.markdownlint-cli2.jsonc
File metadata and controls
47 lines (41 loc) · 1.79 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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
// Lore docs markdownlint config. v1: lean on defaults; disable only the
// rules that mechanically conflict with the project's structure.
// See docs/developing/doc-standards/tools/README.md for usage.
"config": {
"default": true,
// Line length is not enforced in Lore docs. Prose wraps for the reader's
// editor, not for an 80-col gate.
"MD013": false,
// HTML comments are used in templates ("<!-- delete after copying -->").
// No other inline HTML is authored in Lore docs.
"MD033": false,
// Type templates legitimately repeat H3s ("Definition", "When to Use It")
// across H2 sections. Allow duplicates within siblings only.
"MD024": { "siblings_only": true },
// Lore docs require a body H1 that matches the frontmatter `title`.
// markdownlint's default counts the frontmatter title as a heading and
// flags the body H1 as a duplicate. Disable the frontmatter scan so only
// body H1s count toward the "single H1" rule.
"MD025": { "front_matter_title": "" },
// Bold-only lines are the tab-title syntax of the comment-delimited
// content-tab convention (see
// docs/developing/doc-standards/canon/format.md#content-tabs); MD036
// would flag every top-level tab title as emphasis-used-instead-of-heading.
"MD036": false,
// MD046 fires false positives on fenced code blocks inside list steps:
// the blocks appear at 4-space (list-content) indentation, which
// markdownlint reads as the indented-code-block style, so it flags all
// subsequent fenced blocks in the file as inconsistent. Fenced with a
// language tag is the required style per format.md.
"MD046": false
},
"globs": [
"docs/**/*.md",
"README.md"
],
"ignores": [
"**/node_modules/**",
"**/target/**"
]
}