-
Notifications
You must be signed in to change notification settings - Fork 1
/
.markdownlintrc
126 lines (115 loc) · 3.13 KB
/
.markdownlintrc
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
{
"default": true,
/*
* MD001 - Header levels should only increment by one level at a time
*/
"header-increment": true,
/*
* MD002 - First header should be a top level header
*/
"first-header-h1": {
"level": 1
},
/*
* MD003 - Header style
*
* Triggered when different header styles (atx, setext, and 'closed' atx)
* are used in the same document:
*
* # ATX style H1
*
* ## Closed ATX style H2 ##
*
* Setext style H1
* ===============
*/
"header-style": {
// Values: "consistent", "atx", "atx_closed", "setext",
// "setext_with_atx", "setext_with_atx_closed";
//
// Default: "consistent"
"style": "atx"
},
/*
* MD004 - Unordered list style
*
* Triggered when the symbols used in the document for unordered list
* items do not match the configured unordered list style:
*
* * Item 1
* + Item 2
* - Item 3
*/
"ul-style": {
// Values: "consistent", "asterisk", "plus", "dash", "sublist";
// Default: "consistent"
"style": "consistent"
},
/*
* MD005 - Inconsistent indentation for list items at the same level
*
* Triggered when list items are parsed as being at the same level, but
* don't have the same indentation:
*
* * Item 1
* * Nested Item 1
* * Nested Item 2
* * A misaligned item
*/
"list-indent": true,
/*
* MD006 - Consider starting bulleted lists at the beginning of the line
*
* Triggered when top level lists don't start at the beginning of a line:
*
* Some text
*
* * List item
* * List item
*/
"ul-start-left": true,
/*
* MD007 - Unordered list indentation
*
* Triggered when list items are not indented by the configured number of
* spaces.
*/
"ul-indent": {
// Default: 2
"indent": 4
},
/*
* MD009 - Trailing spaces
*
* Triggered on any lines that end with whitespace.
*/
"no-trailing-spaces": {
// Allows an exception to this rule for a specific amount of trailing
// spaces used to insert an explicit line break/br element. For
// example, set br_spaces to 2 to allow exactly 2 spaces at the end of
// a line.
"br_spaces": 2,
// Using spaces to indent blank lines inside a list item is usually
// not necessary, but some parsers require it. Set the
// list_item_empty_lines parameter to true to allow this.
"list_item_empty_lines": true
},
/*
* MD013 - Line length
*
* Triggered when there are lines that are longer than the configured line
* length (default: 80 characters). To fix this, split the line up into
* multiple lines.
*/
"line-length": {
"line_length": 400,
"headers": 80
},
/*
* MD024 - Multiple headers with the same content
*
* Triggered if there are multiple headers in the document that have the
* same text.
*/
"no-duplicate-header": true
}