-
Notifications
You must be signed in to change notification settings - Fork 7
/
.markdownlint.jsonc
306 lines (306 loc) · 12.6 KB
/
.markdownlint.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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
// Example markdownlint configuration with all properties set to their default value
{
// Default state for all rules
"default": true,
// Path to configuration file to extend
"extends": null,
// MD001/heading-increment : Heading levels should only increment by one level at a time
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md
"heading-increment": true,
// MD003/heading-style : Heading style
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md003.md
"heading-style": {
// Heading style
"style": "atx"
},
// MD004/ul-style : Unordered list style
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md004.md
"ul-style": {
// List style
// "style": "consistent"
"style": "asterisk"
},
// MD005/list-indent : Inconsistent indentation for list items at the same level
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md005.md
"list-indent": true,
// MD007/ul-indent : Unordered list indentation
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md007.md
"ul-indent": {
// Spaces for indent
"indent": 4,
// Whether to indent the first level of the list
"start_indented": false,
// Spaces for first level indent (when start_indented is set)
"start_indent": 2
},
// MD009/no-trailing-spaces : Trailing spaces
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md009.md
"no-trailing-spaces": {
// Spaces for line break
"br_spaces": 2,
// Allow spaces for empty lines in list items
"list_item_empty_lines": false,
// Include unnecessary breaks
"strict": false
},
// MD010/no-hard-tabs : Hard tabs
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md010.md
"no-hard-tabs": false, // {
// Include code blocks
// "code_blocks": true,
// Fenced code languages to ignore
// "ignore_code_languages": [],
// Number of spaces for each hard tab
// "spaces_per_tab": 1
// },
// MD011/no-reversed-links : Reversed link syntax
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md011.md
"no-reversed-links": true,
// MD012/no-multiple-blanks : Multiple consecutive blank lines
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md012.md
"no-multiple-blanks": {
// Consecutive blank lines
"maximum": 1
},
// MD013/line-length : Line length
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md013.md
"line-length": false, // {
// Number of characters
// "line_length": 80,
// Number of characters for headings
// "heading_line_length": 80,
// Number of characters for code blocks
// "code_block_line_length": 80,
// Include code blocks
// "code_blocks": true,
// Include tables
// "tables": true,
// Include headings
// "headings": true,
// Strict length checking
// "strict": false,
// Stern length checking
// "stern": false
// },
// MD014/commands-show-output : Dollar signs used before commands without showing output
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md014.md
"commands-show-output": true,
// MD018/no-missing-space-atx : No space after hash on atx style heading
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md018.md
"no-missing-space-atx": true,
// MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md019.md
"no-multiple-space-atx": true,
// MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md020.md
"no-missing-space-closed-atx": false,
// MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md021.md
"no-multiple-space-closed-atx": false,
// MD022/blanks-around-headings : Headings should be surrounded by blank lines
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md022.md
"blanks-around-headings": {
// Blank lines above heading
"lines_above": 1,
// Blank lines below heading
"lines_below": 1
},
// MD023/heading-start-left : Headings must start at the beginning of the line
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md023.md
"heading-start-left": true,
// MD024/no-duplicate-heading : Multiple headings with the same content
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md024.md
"no-duplicate-heading": {
// Only check sibling headings
"siblings_only": false
},
// MD025/single-title/single-h1 : Multiple top-level headings in the same document
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md025.md
"single-title": {
// Heading level
"level": 1,
// RegExp for matching title in front matter
"front_matter_title": "^\\s*title\\s*[:=]"
},
// MD026/no-trailing-punctuation : Trailing punctuation in heading
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md026.md
"no-trailing-punctuation": {
// Punctuation characters
"punctuation": ".,;:!。，；：！"
},
// MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md027.md
"no-multiple-space-blockquote": true,
// MD028/no-blanks-blockquote : Blank line inside blockquote
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md028.md
"no-blanks-blockquote": true,
// MD029/ol-prefix : Ordered list item prefix
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md029.md
"ol-prefix": {
// List style
"style": "one_or_ordered"
},
// MD030/list-marker-space : Spaces after list markers
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md030.md
"list-marker-space": {
// Spaces for single-line unordered list items
"ul_single": 1,
// Spaces for single-line ordered list items
"ol_single": 1,
// Spaces for multi-line unordered list items
"ul_multi": 1,
// Spaces for multi-line ordered list items
"ol_multi": 1
},
// MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md031.md
"blanks-around-fences": {
// Include list items
"list_items": true
},
// MD032/blanks-around-lists : Lists should be surrounded by blank lines
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md032.md
"blanks-around-lists": true,
// MD033/no-inline-html : Inline HTML
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md033.md
"no-inline-html": {
// Allowed elements
"allowed_elements": []
},
// MD034/no-bare-urls : Bare URL used
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md034.md
"no-bare-urls": true,
// MD035/hr-style : Horizontal rule style
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md035.md
"hr-style": {
// Horizontal rule style
"style": "consistent"
},
// MD036/no-emphasis-as-heading : Emphasis used instead of a heading
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md036.md
"no-emphasis-as-heading": {
// Punctuation characters
"punctuation": ".,;:!?。，；：！？"
},
// MD037/no-space-in-emphasis : Spaces inside emphasis markers
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md037.md
"no-space-in-emphasis": true,
// MD038/no-space-in-code : Spaces inside code span elements
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md038.md
"no-space-in-code": true,
// MD039/no-space-in-links : Spaces inside link text
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md039.md
"no-space-in-links": true,
// MD040/fenced-code-language : Fenced code blocks should have a language specified
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md040.md
"fenced-code-language": {
// List of languages
"allowed_languages": [],
// Require language only
"language_only": false
},
// MD041/first-line-heading/first-line-h1
// Rule details : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md041.md
"first-line-heading": {
// Heading level
"level": 1,
// RegExp for matching title in front matter
"front_matter_title": "^\\s*title\\s*[:=]"
},
// MD042/no-empty-links : No empty links
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md042.md
"no-empty-links": true,
// MD043/required-headings : Required heading structure
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md043.md
"required-headings": false, // {
// List of headings
// "headings": [],
// Match case of headings
// "match_case": false
// },
// MD044/proper-names : Proper names should have the correct capitalization
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md044.md
"proper-names": {
// List of proper names
"names": [],
// Include code blocks
"code_blocks": true,
// Include HTML elements
"html_elements": true
},
// MD045/no-alt-text : Images should have alternate text (alt text)
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md045.md
"no-alt-text": true,
// MD046/code-block-style : Code block style
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md046.md
"code-block-style": {
// Block style
// "style": "consistent"
"style": "fenced"
},
// MD047/single-trailing-newline : Files should end with a single newline character
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md047.md
"single-trailing-newline": true,
// MD048/code-fence-style : Code fence style
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md048.md
"code-fence-style": {
// Code fence style
"style": "backtick"
},
// MD049/emphasis-style : Emphasis style
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md049.md
"emphasis-style": {
// Emphasis style
// "style": "consistent"
"style": "underscore"
},
// MD050/strong-style : Strong style
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md050.md
"strong-style": {
// Strong style
// "style": "consistent"
"style": "asterisk"
},
// MD051/link-fragments : Link fragments should be valid
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md051.md
"link-fragments": true,
// MD052/reference-links-images : Reference links and images should use a label that is defined
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md052.md
"reference-links-images": false, // {
// Include shortcut syntax
// "shortcut_syntax": false
// },
// MD053/link-image-reference-definitions : Link and image reference definitions should be needed
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md053.md
"link-image-reference-definitions": {
// Ignored definitions
"ignored_definitions": [
"//"
]
},
// MD054/link-image-style : Link and image style
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md054.md
"link-image-style": {
// Allow autolinks
"autolink": true,
// Allow inline links and images
"inline": true,
// Allow full reference links and images
"full": true,
// Allow collapsed reference links and images
"collapsed": true,
// Allow shortcut reference links and images
"shortcut": true,
// Allow URLs as inline links
"url_inline": true
},
// MD055/table-pipe-style : Table pipe style
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md055.md
"table-pipe-style": {
// Table pipe style
"style": "consistent"
},
// MD056/table-column-count : Table column count
// Rule details : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md056.md
"table-column-count": true
}