|
2 | 2 | "comment": "Be explicit by listing every available rule. https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md", |
3 | 3 | "comment": "Note that there will be numeric gaps, not every MD number is implemented in markdownlint.", |
4 | 4 |
|
5 | | - "comment": "MD001: Header levels should only increment by one level at a time", |
| 5 | + "comment": "MD001: Header levels should only increment by one level at a time.", |
6 | 6 | "header-increment": true, |
7 | 7 |
|
8 | | - "comment": "MD002: First header should be a top level header", |
| 8 | + "comment": "MD002: First header should be a top level header.", |
9 | 9 | "first-header-h1": true, |
10 | 10 |
|
11 | | - "comment": "MD003: Header style: start with hashes", |
| 11 | + "comment": "MD003: Header style: start with hashes.", |
12 | 12 | "header-style": { |
13 | 13 | "style": "atx" |
14 | 14 | }, |
|
18 | 18 | "style": "dash" |
19 | 19 | }, |
20 | 20 |
|
21 | | - "comment": "MD005: Consistent indentation for list items at the same level", |
| 21 | + "comment": "MD005: Consistent indentation for list items at the same level.", |
22 | 22 | "list-indent": true, |
23 | 23 |
|
24 | | - "comment": "MD006: Consider starting bulleted lists at the beginning of the line", |
| 24 | + "comment": "MD006: Consider starting bulleted lists at the beginning of the line.", |
25 | 25 | "ul-start-left": false, |
26 | 26 |
|
27 | | - "comment": "MD007: Unordered list indentation: 2 spaces", |
| 27 | + "comment": "MD007: Unordered list indentation: 2 spaces.", |
28 | 28 | "ul-indent": { |
29 | 29 | "indent": 2 |
30 | 30 | }, |
31 | 31 |
|
32 | | - "comment": "MD009: Disallow trailing spaces", |
| 32 | + "comment": "MD009: Disallow trailing spaces!", |
33 | 33 | "no-trailing-spaces": { |
34 | 34 | "br_spaces": 0, |
35 | | - "comment": "Empty lines inside list items should not be indented", |
| 35 | + "comment": "Empty lines inside list items should not be indented.", |
36 | 36 | "list_item_empty_lines": false |
37 | 37 | }, |
38 | 38 |
|
39 | | - "comment": "MD010: No hard tabs, not even in code blocks", |
| 39 | + "comment": "MD010: No hard tabs, not even in code blocks.", |
40 | 40 | "no-hard-tabs": { |
41 | 41 | "code_blocks": true |
42 | 42 | }, |
43 | 43 |
|
44 | 44 | "comment": "MD011: Prevent reversed link syntax", |
45 | 45 | "no-reversed-links": true, |
46 | 46 |
|
47 | | - "comment": "MD012: Disallow multiple consecutive blank lines", |
| 47 | + "comment": "MD012: Disallow multiple consecutive blank lines.", |
48 | 48 | "no-multiple-blanks": { |
49 | 49 | "maximum": 1 |
50 | 50 | }, |
51 | 51 |
|
52 | 52 | "comment": "MD013: Line length", |
53 | 53 | "line-length": false, |
54 | 54 |
|
55 | | - "comment": "MD014: Disallow dollar signs used before commands without showing output", |
| 55 | + "comment": "MD014: Disallow use of dollar signs($) before commands without showing output.", |
56 | 56 | "commands-show-output": true, |
57 | 57 |
|
58 | | - "comment": "MD018: Disallow space after hash on atx style header", |
| 58 | + "comment": "MD018: Disallow space after hash on atx style header.", |
59 | 59 | "no-missing-space-atx": true, |
60 | 60 |
|
61 | | - "comment": "MD019: Dissalow multiple spaces after hash on atx style header", |
| 61 | + "comment": "MD019: Disallow multiple spaces after hash on atx style header.", |
62 | 62 | "no-multiple-space-atx": true, |
63 | 63 |
|
64 | | - "comment": "MD020: No space inside hashes on closed atx style header", |
| 64 | + "comment": "MD020: No space should be inside hashes on closed atx style header.", |
65 | 65 | "no-missing-space-closed-atx": true, |
66 | 66 |
|
67 | | - "comment": "MD021: Disallow multiple spaces inside hashes on closed atx style header", |
| 67 | + "comment": "MD021: Disallow multiple spaces inside hashes on closed atx style header.", |
68 | 68 | "no-multiple-space-closed-atx": true, |
69 | 69 |
|
70 | | - "comment": "MD022: Headers should be surrounded by blank lines", |
| 70 | + "comment": "MD022: Headers should be surrounded by blank lines.", |
71 | 71 | "comment": "Some headers have preceeding HTML anchors. Unfortunate that we have to disable this, as it otherwise catches a real problem that trips up some Markdown renderers", |
72 | 72 | "blanks-around-headers": false, |
73 | 73 |
|
74 | | - "comment": "MD023: Headers must start at the beginning of the line", |
| 74 | + "comment": "MD023: Headers must start at the beginning of the line.", |
75 | 75 | "header-start-left": true, |
76 | 76 |
|
77 | | - "comment": "MD024: Disallow multiple headers with the same content", |
| 77 | + "comment": "MD024: Disallow multiple headers with the same content.", |
78 | 78 | "no-duplicate-header": true, |
79 | 79 |
|
80 | | - "comment": "MD025: Disallow multiple top level headers in the same document", |
81 | | - "comment": "Gotta have a matching closing brace at the end", |
| 80 | + "comment": "MD025: Disallow multiple top level headers in the same document.", |
| 81 | + "comment": "Gotta have a matching closing brace at the end.", |
82 | 82 | "single-h1": false, |
83 | 83 |
|
84 | | - "comment": "MD026: Disallow trailing punctuation in header", |
85 | | - "comment": "Gotta have a semicolon after the ending closing brace", |
| 84 | + "comment": "MD026: Disallow trailing punctuation in header.", |
| 85 | + "comment": "You must have a semicolon after the ending closing brace.", |
86 | 86 | "no-trailing-punctuation": { |
87 | 87 | "punctuation" : ".,:!?" |
88 | 88 | }, |
|
117 | 117 | "comment": "HTML is needed for explicit anchors", |
118 | 118 | "no-inline-html": false, |
119 | 119 |
|
120 | | - "comment": "MD034: No bare URLs used", |
| 120 | + "comment": "MD034: No bare URLs should be used", |
121 | 121 | "no-bare-urls": true, |
122 | 122 |
|
123 | 123 | "comment": "MD035: Horizontal rule style", |
124 | 124 | "hr-style": { |
125 | 125 | "style": "consistent" |
126 | 126 | }, |
127 | 127 |
|
128 | | - "comment": "MD036: Do not use emphasis instead of a header", |
| 128 | + "comment": "MD036: Do not use emphasis instead of a header.", |
129 | 129 | "no-emphasis-as-header": false, |
130 | 130 |
|
131 | | - "comment": "MD037: Disallow spaces inside emphasis markers", |
| 131 | + "comment": "MD037: Disallow spaces inside emphasis markers.", |
132 | 132 | "no-space-in-emphasis": true, |
133 | 133 |
|
134 | | - "comment": "MD038: Disallow spaces inside code span elements", |
| 134 | + "comment": "MD038: Disallow spaces inside code span elements.", |
135 | 135 | "no-space-in-code": true, |
136 | 136 |
|
137 | | - "comment": "MD039: Disallow spaces inside link text", |
| 137 | + "comment": "MD039: Disallow spaces inside link text.", |
138 | 138 | "no-space-in-links": true, |
139 | 139 |
|
140 | | - "comment": "MD040: Fenced code blocks should have a language specified", |
| 140 | + "comment": "MD040: Fenced code blocks should have a language specified.", |
141 | 141 | "fenced-code-language": true, |
142 | 142 |
|
143 | | - "comment": "MD041: First line in file should be a top level header", |
| 143 | + "comment": "MD041: First line in file should be a top level header.", |
144 | 144 | "first-line-h1": true, |
145 | 145 |
|
146 | 146 | "comment": "MD042: No empty links", |
147 | 147 | "no-empty-links": true, |
148 | 148 |
|
149 | | - "comment": "MD043: Required header structure", |
| 149 | + "comment": "MD043: Required header structure.", |
150 | 150 | "required-headers": false, |
151 | 151 |
|
152 | | - "comment": "MD044: Proper names should have the correct capitalization", |
| 152 | + "comment": "MD044: Proper names should have the correct capitalization.", |
153 | 153 | "proper-names": false |
154 | 154 | } |
0 commit comments