forked from mdn/content
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.markdownlint-cli2.jsonc
165 lines (165 loc) · 3.66 KB
/
.markdownlint-cli2.jsonc
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
{
"config": {
"default": true,
// MD001 - Heading levels should only increment by one level at a time.
// -> Disabled, as some callouts include headings.
"MD001": false,
"MD004": {
"style": "dash"
},
"MD007": {
"indent": 2
},
"MD010": {
"spaces_per_tab": 2
},
"MD013": false,
"MD024": {
"allow_different_nesting": true
},
"MD025": {
"front_matter_title": "^\\s*title\\s*[:=]"
},
"MD026": false,
// Consectutive Notes/Callouts currently don't conform with this rule
"MD028": false,
// Force orderd numbering to catch accidental list ending from indenting
"MD029": {
"style": "ordered"
},
"MD033": {
"allowed_elements": [
"a",
"abbr",
"annotation",
"base",
"br",
"caption",
"code",
"col",
"colgroup",
"dd",
"details",
"dfn",
"div",
"dl",
"dt",
"em",
"h4",
"h5",
"img",
"kbd",
"li",
"math",
"menclose",
"mfenced",
"mfrac",
"mfrac",
"mi",
"mmultiscripts",
"mn",
"mo",
"mover",
"mphantom",
"mprescripts",
"mroot",
"mrow",
"ms",
"mspace",
"mspace",
"msqrt",
"mstyle",
"msub",
"msubsup",
"msup",
"mtable",
"mtd",
"mtext",
"mtr",
"munder",
"munderover",
"none",
"ol",
"p",
"pre",
"section",
"semantics",
"strong",
"sub",
"summary",
"sup",
"table",
"tbody",
"td",
"tfoot",
"th",
"thead",
"tr",
"ul",
"var"
]
},
// Pending https://github.com/mdn/content/pull/20115
"MD037": false,
"MD040": false,
// See https://github.com/mdn/content/pull/20026, as macros currently break this
"MD042": false,
// Tracked as part of https://github.com/mdn/content/pull/19334
"MD045": false,
"MD046": {
"style": "fenced"
},
"MD049": {
"style": "underscore"
},
"MD050": {
"style": "asterisk"
},
// MD051 - Link fragments should be valid.
// -> Disabled, as yari generates link fragments by replacing spaces with underscores, not dashes.
"MD051": false,
// Incompatible with brackets in macros like MD042
"MD052": false,
"search-replace": {
"rules": [
{
"name": "curly-double-quotes",
"message": "Don't use curly double quotes",
"searchPattern": "/“|”/g",
"replace": "\"",
"skipCode": true
},
{
"name": "curly-single-quotes",
"message": "Don't use curly single quotes",
"searchPattern": "/‘|’/g",
"replace": "'",
"skipCode": true
},
{
"name": "m-dash",
"message": "Don't use '--'. Use m-dash — instead",
"search": " -- ",
"replace": " — ",
"skipCode": true
},
{
"name": "relative-link",
"message": "Internal links should start with '/'",
"search": "(en-US/docs",
"replace": "(/en-US/docs",
"skipCode": true
},
{
"name": "trailing-spaces",
"message": "Avoid trailing spaces",
"searchPattern": "/ +$/gm",
"replace": "",
"skipCode": false
}
]
}
},
"customRules": ["markdownlint-rule-search-replace"],
"ignores": ["node_modules"]
}