markdownlint 0.31.1 → 0.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/CONTRIBUTING.md +2 -2
- package/README.md +19 -28
- package/demo/markdownlint-browser.js +521 -352
- package/doc/Rules.md +146 -127
- package/doc/md001.md +2 -2
- package/doc/md003.md +2 -2
- package/doc/md007.md +3 -4
- package/doc/md013.md +0 -3
- package/doc/md018.md +1 -1
- package/doc/md019.md +1 -1
- package/doc/md020.md +1 -1
- package/doc/md021.md +1 -1
- package/doc/md022.md +2 -2
- package/doc/md023.md +9 -2
- package/doc/md024.md +2 -2
- package/doc/md025.md +1 -1
- package/doc/md026.md +1 -1
- package/doc/md036.md +2 -2
- package/doc/md041.md +1 -1
- package/doc/md043.md +2 -5
- package/doc/md045.md +6 -0
- package/doc/md049.md +1 -1
- package/doc/md050.md +1 -1
- package/doc/md053.md +3 -3
- package/doc/md054.md +100 -0
- package/helpers/helpers.js +27 -7
- package/helpers/micromark.cjs +62 -15
- package/helpers/package.json +2 -1
- package/helpers/shared.js +3 -0
- package/lib/configuration.d.ts +1152 -0
- package/lib/constants.js +7 -7
- package/lib/markdownlint.d.ts +2 -4
- package/lib/markdownlint.js +9 -8
- package/lib/md001.js +2 -2
- package/lib/md003.js +2 -2
- package/lib/md005.js +21 -17
- package/lib/md007.js +62 -25
- package/lib/md013.js +1 -4
- package/lib/md018.js +1 -1
- package/lib/md019.js +1 -1
- package/lib/md020.js +1 -1
- package/lib/md021.js +1 -1
- package/lib/md022.js +4 -4
- package/lib/md023.js +2 -2
- package/lib/md024.js +2 -2
- package/lib/md025.js +1 -1
- package/lib/md026.js +1 -1
- package/lib/md030.js +33 -22
- package/lib/md032.js +1 -4
- package/lib/md033.js +1 -3
- package/lib/md034.js +31 -25
- package/lib/md036.js +2 -2
- package/lib/md037.js +2 -2
- package/lib/md038.js +7 -5
- package/lib/md041.js +1 -1
- package/lib/md043.js +3 -3
- package/lib/md045.js +33 -3
- package/lib/md049-md050.js +2 -2
- package/lib/md051.js +8 -6
- package/lib/md053.js +1 -1
- package/lib/md054.js +118 -0
- package/lib/rules.js +5 -3
- package/package.json +17 -15
- package/schema/.markdownlint.jsonc +63 -60
- package/schema/.markdownlint.yaml +62 -59
- package/schema/markdownlint-config-schema.json +840 -186
- package/style/relaxed.json +0 -1
- package/doc/md002.md +0 -37
- package/doc/md006.md +0 -46
- package/lib/md002.js +0 -22
- package/lib/md006.js +0 -34
|
@@ -7,34 +7,25 @@
|
|
|
7
7
|
// Path to configuration file to extend
|
|
8
8
|
"extends": null,
|
|
9
9
|
|
|
10
|
-
// MD001/heading-increment
|
|
10
|
+
// MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md001.md
|
|
11
11
|
"MD001": true,
|
|
12
12
|
|
|
13
|
-
//
|
|
14
|
-
"MD002": {
|
|
15
|
-
// Heading level
|
|
16
|
-
"level": 1
|
|
17
|
-
},
|
|
18
|
-
|
|
19
|
-
// MD003/heading-style/header-style - Heading style
|
|
13
|
+
// MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md003.md
|
|
20
14
|
"MD003": {
|
|
21
15
|
// Heading style
|
|
22
16
|
"style": "consistent"
|
|
23
17
|
},
|
|
24
18
|
|
|
25
|
-
// MD004/ul-style
|
|
19
|
+
// MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md004.md
|
|
26
20
|
"MD004": {
|
|
27
21
|
// List style
|
|
28
22
|
"style": "consistent"
|
|
29
23
|
},
|
|
30
24
|
|
|
31
|
-
// MD005/list-indent
|
|
25
|
+
// MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md005.md
|
|
32
26
|
"MD005": true,
|
|
33
27
|
|
|
34
|
-
//
|
|
35
|
-
"MD006": true,
|
|
36
|
-
|
|
37
|
-
// MD007/ul-indent - Unordered list indentation
|
|
28
|
+
// MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md007.md
|
|
38
29
|
"MD007": {
|
|
39
30
|
// Spaces for indent
|
|
40
31
|
"indent": 2,
|
|
@@ -44,7 +35,7 @@
|
|
|
44
35
|
"start_indent": 2
|
|
45
36
|
},
|
|
46
37
|
|
|
47
|
-
// MD009/no-trailing-spaces
|
|
38
|
+
// MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md009.md
|
|
48
39
|
"MD009": {
|
|
49
40
|
// Spaces for line break
|
|
50
41
|
"br_spaces": 2,
|
|
@@ -54,7 +45,7 @@
|
|
|
54
45
|
"strict": false
|
|
55
46
|
},
|
|
56
47
|
|
|
57
|
-
// MD010/no-hard-tabs
|
|
48
|
+
// MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md010.md
|
|
58
49
|
"MD010": {
|
|
59
50
|
// Include code blocks
|
|
60
51
|
"code_blocks": true,
|
|
@@ -64,16 +55,16 @@
|
|
|
64
55
|
"spaces_per_tab": 1
|
|
65
56
|
},
|
|
66
57
|
|
|
67
|
-
// MD011/no-reversed-links
|
|
58
|
+
// MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md011.md
|
|
68
59
|
"MD011": true,
|
|
69
60
|
|
|
70
|
-
// MD012/no-multiple-blanks
|
|
61
|
+
// MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md012.md
|
|
71
62
|
"MD012": {
|
|
72
63
|
// Consecutive blank lines
|
|
73
64
|
"maximum": 1
|
|
74
65
|
},
|
|
75
66
|
|
|
76
|
-
// MD013/line-length
|
|
67
|
+
// MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md013.md
|
|
77
68
|
"MD013": {
|
|
78
69
|
// Number of characters
|
|
79
70
|
"line_length": 80,
|
|
@@ -87,30 +78,28 @@
|
|
|
87
78
|
"tables": true,
|
|
88
79
|
// Include headings
|
|
89
80
|
"headings": true,
|
|
90
|
-
// Include headings
|
|
91
|
-
"headers": true,
|
|
92
81
|
// Strict length checking
|
|
93
82
|
"strict": false,
|
|
94
83
|
// Stern length checking
|
|
95
84
|
"stern": false
|
|
96
85
|
},
|
|
97
86
|
|
|
98
|
-
// MD014/commands-show-output
|
|
87
|
+
// MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md014.md
|
|
99
88
|
"MD014": true,
|
|
100
89
|
|
|
101
|
-
// MD018/no-missing-space-atx
|
|
90
|
+
// MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md018.md
|
|
102
91
|
"MD018": true,
|
|
103
92
|
|
|
104
|
-
// MD019/no-multiple-space-atx
|
|
93
|
+
// MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md019.md
|
|
105
94
|
"MD019": true,
|
|
106
95
|
|
|
107
|
-
// MD020/no-missing-space-closed-atx
|
|
96
|
+
// MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md020.md
|
|
108
97
|
"MD020": true,
|
|
109
98
|
|
|
110
|
-
// MD021/no-multiple-space-closed-atx
|
|
99
|
+
// MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md021.md
|
|
111
100
|
"MD021": true,
|
|
112
101
|
|
|
113
|
-
// MD022/blanks-around-headings
|
|
102
|
+
// MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md022.md
|
|
114
103
|
"MD022": {
|
|
115
104
|
// Blank lines above heading
|
|
116
105
|
"lines_above": 1,
|
|
@@ -118,10 +107,10 @@
|
|
|
118
107
|
"lines_below": 1
|
|
119
108
|
},
|
|
120
109
|
|
|
121
|
-
// MD023/heading-start-left
|
|
110
|
+
// MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md023.md
|
|
122
111
|
"MD023": true,
|
|
123
112
|
|
|
124
|
-
// MD024/no-duplicate-heading
|
|
113
|
+
// MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md024.md
|
|
125
114
|
"MD024": {
|
|
126
115
|
// Only check sibling headings
|
|
127
116
|
"allow_different_nesting": false,
|
|
@@ -129,7 +118,7 @@
|
|
|
129
118
|
"siblings_only": false
|
|
130
119
|
},
|
|
131
120
|
|
|
132
|
-
// MD025/single-title/single-h1
|
|
121
|
+
// MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md025.md
|
|
133
122
|
"MD025": {
|
|
134
123
|
// Heading level
|
|
135
124
|
"level": 1,
|
|
@@ -137,25 +126,25 @@
|
|
|
137
126
|
"front_matter_title": "^\\s*title\\s*[:=]"
|
|
138
127
|
},
|
|
139
128
|
|
|
140
|
-
// MD026/no-trailing-punctuation
|
|
129
|
+
// MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md026.md
|
|
141
130
|
"MD026": {
|
|
142
131
|
// Punctuation characters
|
|
143
132
|
"punctuation": ".,;:!。,;:!"
|
|
144
133
|
},
|
|
145
134
|
|
|
146
|
-
// MD027/no-multiple-space-blockquote
|
|
135
|
+
// MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md027.md
|
|
147
136
|
"MD027": true,
|
|
148
137
|
|
|
149
|
-
// MD028/no-blanks-blockquote
|
|
138
|
+
// MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md028.md
|
|
150
139
|
"MD028": true,
|
|
151
140
|
|
|
152
|
-
// MD029/ol-prefix
|
|
141
|
+
// MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md029.md
|
|
153
142
|
"MD029": {
|
|
154
143
|
// List style
|
|
155
144
|
"style": "one_or_ordered"
|
|
156
145
|
},
|
|
157
146
|
|
|
158
|
-
// MD030/list-marker-space
|
|
147
|
+
// MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md030.md
|
|
159
148
|
"MD030": {
|
|
160
149
|
// Spaces for single-line unordered list items
|
|
161
150
|
"ul_single": 1,
|
|
@@ -167,46 +156,46 @@
|
|
|
167
156
|
"ol_multi": 1
|
|
168
157
|
},
|
|
169
158
|
|
|
170
|
-
// MD031/blanks-around-fences
|
|
159
|
+
// MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md031.md
|
|
171
160
|
"MD031": {
|
|
172
161
|
// Include list items
|
|
173
162
|
"list_items": true
|
|
174
163
|
},
|
|
175
164
|
|
|
176
|
-
// MD032/blanks-around-lists
|
|
165
|
+
// MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md032.md
|
|
177
166
|
"MD032": true,
|
|
178
167
|
|
|
179
|
-
// MD033/no-inline-html
|
|
168
|
+
// MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md033.md
|
|
180
169
|
"MD033": {
|
|
181
170
|
// Allowed elements
|
|
182
171
|
"allowed_elements": []
|
|
183
172
|
},
|
|
184
173
|
|
|
185
|
-
// MD034/no-bare-urls
|
|
174
|
+
// MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md034.md
|
|
186
175
|
"MD034": true,
|
|
187
176
|
|
|
188
|
-
// MD035/hr-style
|
|
177
|
+
// MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md035.md
|
|
189
178
|
"MD035": {
|
|
190
179
|
// Horizontal rule style
|
|
191
180
|
"style": "consistent"
|
|
192
181
|
},
|
|
193
182
|
|
|
194
|
-
// MD036/no-emphasis-as-heading
|
|
183
|
+
// MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md036.md
|
|
195
184
|
"MD036": {
|
|
196
185
|
// Punctuation characters
|
|
197
186
|
"punctuation": ".,;:!?。,;:!?"
|
|
198
187
|
},
|
|
199
188
|
|
|
200
|
-
// MD037/no-space-in-emphasis
|
|
189
|
+
// MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md037.md
|
|
201
190
|
"MD037": true,
|
|
202
191
|
|
|
203
|
-
// MD038/no-space-in-code
|
|
192
|
+
// MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md038.md
|
|
204
193
|
"MD038": true,
|
|
205
194
|
|
|
206
|
-
// MD039/no-space-in-links
|
|
195
|
+
// MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md039.md
|
|
207
196
|
"MD039": true,
|
|
208
197
|
|
|
209
|
-
// MD040/fenced-code-language
|
|
198
|
+
// MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md040.md
|
|
210
199
|
"MD040": {
|
|
211
200
|
// List of languages
|
|
212
201
|
"allowed_languages": [],
|
|
@@ -214,7 +203,7 @@
|
|
|
214
203
|
"language_only": false
|
|
215
204
|
},
|
|
216
205
|
|
|
217
|
-
// MD041/first-line-heading/first-line-h1
|
|
206
|
+
// MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md041.md
|
|
218
207
|
"MD041": {
|
|
219
208
|
// Heading level
|
|
220
209
|
"level": 1,
|
|
@@ -222,20 +211,18 @@
|
|
|
222
211
|
"front_matter_title": "^\\s*title\\s*[:=]"
|
|
223
212
|
},
|
|
224
213
|
|
|
225
|
-
// MD042/no-empty-links
|
|
214
|
+
// MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md042.md
|
|
226
215
|
"MD042": true,
|
|
227
216
|
|
|
228
|
-
// MD043/required-headings
|
|
217
|
+
// MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md043.md
|
|
229
218
|
"MD043": {
|
|
230
219
|
// List of headings
|
|
231
220
|
"headings": [],
|
|
232
|
-
// List of headings
|
|
233
|
-
"headers": [],
|
|
234
221
|
// Match case of headings
|
|
235
222
|
"match_case": false
|
|
236
223
|
},
|
|
237
224
|
|
|
238
|
-
// MD044/proper-names
|
|
225
|
+
// MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md044.md
|
|
239
226
|
"MD044": {
|
|
240
227
|
// List of proper names
|
|
241
228
|
"names": [],
|
|
@@ -245,50 +232,66 @@
|
|
|
245
232
|
"html_elements": true
|
|
246
233
|
},
|
|
247
234
|
|
|
248
|
-
// MD045/no-alt-text
|
|
235
|
+
// MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md045.md
|
|
249
236
|
"MD045": true,
|
|
250
237
|
|
|
251
|
-
// MD046/code-block-style
|
|
238
|
+
// MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md046.md
|
|
252
239
|
"MD046": {
|
|
253
240
|
// Block style
|
|
254
241
|
"style": "consistent"
|
|
255
242
|
},
|
|
256
243
|
|
|
257
|
-
// MD047/single-trailing-newline
|
|
244
|
+
// MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md047.md
|
|
258
245
|
"MD047": true,
|
|
259
246
|
|
|
260
|
-
// MD048/code-fence-style
|
|
247
|
+
// MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md048.md
|
|
261
248
|
"MD048": {
|
|
262
249
|
// Code fence style
|
|
263
250
|
"style": "consistent"
|
|
264
251
|
},
|
|
265
252
|
|
|
266
|
-
// MD049/emphasis-style
|
|
253
|
+
// MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md049.md
|
|
267
254
|
"MD049": {
|
|
268
255
|
// Emphasis style
|
|
269
256
|
"style": "consistent"
|
|
270
257
|
},
|
|
271
258
|
|
|
272
|
-
// MD050/strong-style
|
|
259
|
+
// MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md050.md
|
|
273
260
|
"MD050": {
|
|
274
261
|
// Strong style
|
|
275
262
|
"style": "consistent"
|
|
276
263
|
},
|
|
277
264
|
|
|
278
|
-
// MD051/link-fragments
|
|
265
|
+
// MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md051.md
|
|
279
266
|
"MD051": true,
|
|
280
267
|
|
|
281
|
-
// MD052/reference-links-images
|
|
268
|
+
// MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md052.md
|
|
282
269
|
"MD052": {
|
|
283
270
|
// Include shortcut syntax
|
|
284
271
|
"shortcut_syntax": false
|
|
285
272
|
},
|
|
286
273
|
|
|
287
|
-
// MD053/link-image-reference-definitions
|
|
274
|
+
// MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md053.md
|
|
288
275
|
"MD053": {
|
|
289
276
|
// Ignored definitions
|
|
290
277
|
"ignored_definitions": [
|
|
291
278
|
"//"
|
|
292
279
|
]
|
|
280
|
+
},
|
|
281
|
+
|
|
282
|
+
// MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md054.md
|
|
283
|
+
"MD054": {
|
|
284
|
+
// Allow autolinks
|
|
285
|
+
"autolink": true,
|
|
286
|
+
// Allow inline links and images
|
|
287
|
+
"inline": true,
|
|
288
|
+
// Allow full reference links and images
|
|
289
|
+
"full": true,
|
|
290
|
+
// Allow collapsed reference links and images
|
|
291
|
+
"collapsed": true,
|
|
292
|
+
// Allow shortcut reference links and images
|
|
293
|
+
"shortcut": true,
|
|
294
|
+
// Allow URLs as inline links
|
|
295
|
+
"url_inline": true
|
|
293
296
|
}
|
|
294
297
|
}
|
|
@@ -6,31 +6,23 @@ default: true
|
|
|
6
6
|
# Path to configuration file to extend
|
|
7
7
|
extends: null
|
|
8
8
|
|
|
9
|
-
# MD001/heading-increment
|
|
9
|
+
# MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md001.md
|
|
10
10
|
MD001: true
|
|
11
11
|
|
|
12
|
-
#
|
|
13
|
-
MD002:
|
|
14
|
-
# Heading level
|
|
15
|
-
level: 1
|
|
16
|
-
|
|
17
|
-
# MD003/heading-style/header-style - Heading style
|
|
12
|
+
# MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md003.md
|
|
18
13
|
MD003:
|
|
19
14
|
# Heading style
|
|
20
15
|
style: "consistent"
|
|
21
16
|
|
|
22
|
-
# MD004/ul-style
|
|
17
|
+
# MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md004.md
|
|
23
18
|
MD004:
|
|
24
19
|
# List style
|
|
25
20
|
style: "consistent"
|
|
26
21
|
|
|
27
|
-
# MD005/list-indent
|
|
22
|
+
# MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md005.md
|
|
28
23
|
MD005: true
|
|
29
24
|
|
|
30
|
-
#
|
|
31
|
-
MD006: true
|
|
32
|
-
|
|
33
|
-
# MD007/ul-indent - Unordered list indentation
|
|
25
|
+
# MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md007.md
|
|
34
26
|
MD007:
|
|
35
27
|
# Spaces for indent
|
|
36
28
|
indent: 2
|
|
@@ -39,7 +31,7 @@ MD007:
|
|
|
39
31
|
# Spaces for first level indent (when start_indented is set)
|
|
40
32
|
start_indent: 2
|
|
41
33
|
|
|
42
|
-
# MD009/no-trailing-spaces
|
|
34
|
+
# MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md009.md
|
|
43
35
|
MD009:
|
|
44
36
|
# Spaces for line break
|
|
45
37
|
br_spaces: 2
|
|
@@ -48,7 +40,7 @@ MD009:
|
|
|
48
40
|
# Include unnecessary breaks
|
|
49
41
|
strict: false
|
|
50
42
|
|
|
51
|
-
# MD010/no-hard-tabs
|
|
43
|
+
# MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md010.md
|
|
52
44
|
MD010:
|
|
53
45
|
# Include code blocks
|
|
54
46
|
code_blocks: true
|
|
@@ -57,15 +49,15 @@ MD010:
|
|
|
57
49
|
# Number of spaces for each hard tab
|
|
58
50
|
spaces_per_tab: 1
|
|
59
51
|
|
|
60
|
-
# MD011/no-reversed-links
|
|
52
|
+
# MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md011.md
|
|
61
53
|
MD011: true
|
|
62
54
|
|
|
63
|
-
# MD012/no-multiple-blanks
|
|
55
|
+
# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md012.md
|
|
64
56
|
MD012:
|
|
65
57
|
# Consecutive blank lines
|
|
66
58
|
maximum: 1
|
|
67
59
|
|
|
68
|
-
# MD013/line-length
|
|
60
|
+
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md013.md
|
|
69
61
|
MD013:
|
|
70
62
|
# Number of characters
|
|
71
63
|
line_length: 80
|
|
@@ -79,69 +71,67 @@ MD013:
|
|
|
79
71
|
tables: true
|
|
80
72
|
# Include headings
|
|
81
73
|
headings: true
|
|
82
|
-
# Include headings
|
|
83
|
-
headers: true
|
|
84
74
|
# Strict length checking
|
|
85
75
|
strict: false
|
|
86
76
|
# Stern length checking
|
|
87
77
|
stern: false
|
|
88
78
|
|
|
89
|
-
# MD014/commands-show-output
|
|
79
|
+
# MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md014.md
|
|
90
80
|
MD014: true
|
|
91
81
|
|
|
92
|
-
# MD018/no-missing-space-atx
|
|
82
|
+
# MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md018.md
|
|
93
83
|
MD018: true
|
|
94
84
|
|
|
95
|
-
# MD019/no-multiple-space-atx
|
|
85
|
+
# MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md019.md
|
|
96
86
|
MD019: true
|
|
97
87
|
|
|
98
|
-
# MD020/no-missing-space-closed-atx
|
|
88
|
+
# MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md020.md
|
|
99
89
|
MD020: true
|
|
100
90
|
|
|
101
|
-
# MD021/no-multiple-space-closed-atx
|
|
91
|
+
# MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md021.md
|
|
102
92
|
MD021: true
|
|
103
93
|
|
|
104
|
-
# MD022/blanks-around-headings
|
|
94
|
+
# MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md022.md
|
|
105
95
|
MD022:
|
|
106
96
|
# Blank lines above heading
|
|
107
97
|
lines_above: 1
|
|
108
98
|
# Blank lines below heading
|
|
109
99
|
lines_below: 1
|
|
110
100
|
|
|
111
|
-
# MD023/heading-start-left
|
|
101
|
+
# MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md023.md
|
|
112
102
|
MD023: true
|
|
113
103
|
|
|
114
|
-
# MD024/no-duplicate-heading
|
|
104
|
+
# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md024.md
|
|
115
105
|
MD024:
|
|
116
106
|
# Only check sibling headings
|
|
117
107
|
allow_different_nesting: false
|
|
118
108
|
# Only check sibling headings
|
|
119
109
|
siblings_only: false
|
|
120
110
|
|
|
121
|
-
# MD025/single-title/single-h1
|
|
111
|
+
# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md025.md
|
|
122
112
|
MD025:
|
|
123
113
|
# Heading level
|
|
124
114
|
level: 1
|
|
125
115
|
# RegExp for matching title in front matter
|
|
126
116
|
front_matter_title: "^\\s*title\\s*[:=]"
|
|
127
117
|
|
|
128
|
-
# MD026/no-trailing-punctuation
|
|
118
|
+
# MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md026.md
|
|
129
119
|
MD026:
|
|
130
120
|
# Punctuation characters
|
|
131
121
|
punctuation: ".,;:!。,;:!"
|
|
132
122
|
|
|
133
|
-
# MD027/no-multiple-space-blockquote
|
|
123
|
+
# MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md027.md
|
|
134
124
|
MD027: true
|
|
135
125
|
|
|
136
|
-
# MD028/no-blanks-blockquote
|
|
126
|
+
# MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md028.md
|
|
137
127
|
MD028: true
|
|
138
128
|
|
|
139
|
-
# MD029/ol-prefix
|
|
129
|
+
# MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md029.md
|
|
140
130
|
MD029:
|
|
141
131
|
# List style
|
|
142
132
|
style: "one_or_ordered"
|
|
143
133
|
|
|
144
|
-
# MD030/list-marker-space
|
|
134
|
+
# MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md030.md
|
|
145
135
|
MD030:
|
|
146
136
|
# Spaces for single-line unordered list items
|
|
147
137
|
ul_single: 1
|
|
@@ -152,68 +142,66 @@ MD030:
|
|
|
152
142
|
# Spaces for multi-line ordered list items
|
|
153
143
|
ol_multi: 1
|
|
154
144
|
|
|
155
|
-
# MD031/blanks-around-fences
|
|
145
|
+
# MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md031.md
|
|
156
146
|
MD031:
|
|
157
147
|
# Include list items
|
|
158
148
|
list_items: true
|
|
159
149
|
|
|
160
|
-
# MD032/blanks-around-lists
|
|
150
|
+
# MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md032.md
|
|
161
151
|
MD032: true
|
|
162
152
|
|
|
163
|
-
# MD033/no-inline-html
|
|
153
|
+
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md033.md
|
|
164
154
|
MD033:
|
|
165
155
|
# Allowed elements
|
|
166
156
|
allowed_elements: []
|
|
167
157
|
|
|
168
|
-
# MD034/no-bare-urls
|
|
158
|
+
# MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md034.md
|
|
169
159
|
MD034: true
|
|
170
160
|
|
|
171
|
-
# MD035/hr-style
|
|
161
|
+
# MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md035.md
|
|
172
162
|
MD035:
|
|
173
163
|
# Horizontal rule style
|
|
174
164
|
style: "consistent"
|
|
175
165
|
|
|
176
|
-
# MD036/no-emphasis-as-heading
|
|
166
|
+
# MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md036.md
|
|
177
167
|
MD036:
|
|
178
168
|
# Punctuation characters
|
|
179
169
|
punctuation: ".,;:!?。,;:!?"
|
|
180
170
|
|
|
181
|
-
# MD037/no-space-in-emphasis
|
|
171
|
+
# MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md037.md
|
|
182
172
|
MD037: true
|
|
183
173
|
|
|
184
|
-
# MD038/no-space-in-code
|
|
174
|
+
# MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md038.md
|
|
185
175
|
MD038: true
|
|
186
176
|
|
|
187
|
-
# MD039/no-space-in-links
|
|
177
|
+
# MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md039.md
|
|
188
178
|
MD039: true
|
|
189
179
|
|
|
190
|
-
# MD040/fenced-code-language
|
|
180
|
+
# MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md040.md
|
|
191
181
|
MD040:
|
|
192
182
|
# List of languages
|
|
193
183
|
allowed_languages: []
|
|
194
184
|
# Require language only
|
|
195
185
|
language_only: false
|
|
196
186
|
|
|
197
|
-
# MD041/first-line-heading/first-line-h1
|
|
187
|
+
# MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md041.md
|
|
198
188
|
MD041:
|
|
199
189
|
# Heading level
|
|
200
190
|
level: 1
|
|
201
191
|
# RegExp for matching title in front matter
|
|
202
192
|
front_matter_title: "^\\s*title\\s*[:=]"
|
|
203
193
|
|
|
204
|
-
# MD042/no-empty-links
|
|
194
|
+
# MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md042.md
|
|
205
195
|
MD042: true
|
|
206
196
|
|
|
207
|
-
# MD043/required-headings
|
|
197
|
+
# MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md043.md
|
|
208
198
|
MD043:
|
|
209
199
|
# List of headings
|
|
210
200
|
headings: []
|
|
211
|
-
# List of headings
|
|
212
|
-
headers: []
|
|
213
201
|
# Match case of headings
|
|
214
202
|
match_case: false
|
|
215
203
|
|
|
216
|
-
# MD044/proper-names
|
|
204
|
+
# MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md044.md
|
|
217
205
|
MD044:
|
|
218
206
|
# List of proper names
|
|
219
207
|
names: []
|
|
@@ -222,42 +210,57 @@ MD044:
|
|
|
222
210
|
# Include HTML elements
|
|
223
211
|
html_elements: true
|
|
224
212
|
|
|
225
|
-
# MD045/no-alt-text
|
|
213
|
+
# MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md045.md
|
|
226
214
|
MD045: true
|
|
227
215
|
|
|
228
|
-
# MD046/code-block-style
|
|
216
|
+
# MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md046.md
|
|
229
217
|
MD046:
|
|
230
218
|
# Block style
|
|
231
219
|
style: "consistent"
|
|
232
220
|
|
|
233
|
-
# MD047/single-trailing-newline
|
|
221
|
+
# MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md047.md
|
|
234
222
|
MD047: true
|
|
235
223
|
|
|
236
|
-
# MD048/code-fence-style
|
|
224
|
+
# MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md048.md
|
|
237
225
|
MD048:
|
|
238
226
|
# Code fence style
|
|
239
227
|
style: "consistent"
|
|
240
228
|
|
|
241
|
-
# MD049/emphasis-style
|
|
229
|
+
# MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md049.md
|
|
242
230
|
MD049:
|
|
243
231
|
# Emphasis style
|
|
244
232
|
style: "consistent"
|
|
245
233
|
|
|
246
|
-
# MD050/strong-style
|
|
234
|
+
# MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md050.md
|
|
247
235
|
MD050:
|
|
248
236
|
# Strong style
|
|
249
237
|
style: "consistent"
|
|
250
238
|
|
|
251
|
-
# MD051/link-fragments
|
|
239
|
+
# MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md051.md
|
|
252
240
|
MD051: true
|
|
253
241
|
|
|
254
|
-
# MD052/reference-links-images
|
|
242
|
+
# MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md052.md
|
|
255
243
|
MD052:
|
|
256
244
|
# Include shortcut syntax
|
|
257
245
|
shortcut_syntax: false
|
|
258
246
|
|
|
259
|
-
# MD053/link-image-reference-definitions
|
|
247
|
+
# MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md053.md
|
|
260
248
|
MD053:
|
|
261
249
|
# Ignored definitions
|
|
262
250
|
ignored_definitions:
|
|
263
251
|
- "//"
|
|
252
|
+
|
|
253
|
+
# MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.32.0/doc/md054.md
|
|
254
|
+
MD054:
|
|
255
|
+
# Allow autolinks
|
|
256
|
+
autolink: true
|
|
257
|
+
# Allow inline links and images
|
|
258
|
+
inline: true
|
|
259
|
+
# Allow full reference links and images
|
|
260
|
+
full: true
|
|
261
|
+
# Allow collapsed reference links and images
|
|
262
|
+
collapsed: true
|
|
263
|
+
# Allow shortcut reference links and images
|
|
264
|
+
shortcut: true
|
|
265
|
+
# Allow URLs as inline links
|
|
266
|
+
url_inline: true
|