Skip to content

Commit 08c450f

Browse files
authored
Update markdownlint rules (#371)
* Update markdownlint rules * Update json config to match
1 parent d596471 commit 08c450f

2 files changed

Lines changed: 111 additions & 95 deletions

File tree

.markdownlint.json

Lines changed: 92 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,24 @@
11
{
2-
"blanks-around-fences": true,
3-
"blanks-around-headers": true,
4-
"blanks-around-lists": true,
5-
"code-block-style": {
6-
"style": "fenced"
7-
},
8-
"code-fence-style": {
9-
"style": "backtick"
10-
},
11-
"commands-show-output": true,
12-
"docsmd.alert": true,
13-
"docsmd.codesnippet": true,
14-
"docsmd.column": true,
15-
"docsmd.image": true,
16-
"docsmd.moniker": true,
17-
"docsmd.no-loc": true,
18-
"docsmd.row": true,
19-
"docsmd.securelinks": true,
20-
"docsmd.syntax": true,
21-
"docsmd.video": true,
22-
"docsmd.xref": true,
23-
"docsmd.zone": true,
24-
"emphasis-style": {
25-
"style": "underscore"
2+
"MD001": true,
3+
"MD003": {
4+
"style": "atx"
265
},
27-
"fenced-code-language": false,
28-
"first-line-h1": {
29-
"front_matter_title": ""
6+
"MD004": {
7+
"style": "dash"
308
},
31-
"header-increment": true,
32-
"header-start-left": true,
33-
"header-style": {
34-
"style": "atx"
9+
"MD005": true,
10+
"MD007": {
11+
"indent": 2,
12+
"start_indented": false
3513
},
36-
"hr-style": {
37-
"style": "---"
14+
"MD009": {
15+
"br_spaces": 2,
16+
"strict": true
3817
},
39-
"line-length": {
18+
"MD010": true,
19+
"MD011": true,
20+
"MD012": true,
21+
"MD013": {
4022
"code_block_line_length": 90,
4123
"code_blocks": true,
4224
"heading_line_length": 100,
@@ -45,18 +27,32 @@
4527
"stern": true,
4628
"tables": false
4729
},
48-
"list-indent": true,
49-
"list-marker-space": true,
50-
"no-alt-text": true,
51-
"no-bare-urls": true,
52-
"no-blanks-blockquote": true,
53-
"no-duplicate-header": {
30+
"MD014": true,
31+
"MD018": true,
32+
"MD019": true,
33+
"MD020": true,
34+
"MD021": true,
35+
"MD022": true,
36+
"MD023": true,
37+
"MD024": {
5438
"siblings_only": true
5539
},
56-
"no-emphasis-as-header": true,
57-
"no-empty-links": true,
58-
"no-hard-tabs": true,
59-
"no-inline-html": {
40+
"MD025": {
41+
"front_matter_title": "",
42+
"level": 1
43+
},
44+
"MD026": {
45+
"punctuation": ".,;:!。,;:!?"
46+
},
47+
"MD027": true,
48+
"MD028": true,
49+
"MD029": {
50+
"style": "one"
51+
},
52+
"MD030": true,
53+
"MD031": true,
54+
"MD032": true,
55+
"MD033": {
6056
"allowed_elements": [
6157
"a",
6258
"br",
@@ -69,27 +65,21 @@
6965
"ul"
7066
]
7167
},
72-
"no-missing-space-atx": true,
73-
"no-missing-space-closed-atx": true,
74-
"no-multiple-blanks": true,
75-
"no-multiple-space-atx": true,
76-
"no-multiple-space-blockquote": true,
77-
"no-multiple-space-closed-atx": true,
78-
"no-reversed-links": true,
79-
"no-space-in-code": true,
80-
"no-space-in-emphasis": true,
81-
"no-space-in-links": true,
82-
"no-trailing-punctuation": {
83-
"punctuation": ".,;:!。,;:!?"
84-
},
85-
"no-trailing-spaces": {
86-
"br_spaces": 2,
87-
"strict": true
68+
"MD034": true,
69+
"MD035": {
70+
"style": "---"
8871
},
89-
"ol-prefix": {
90-
"style": "one"
72+
"MD036": true,
73+
"MD037": true,
74+
"MD038": true,
75+
"MD039": true,
76+
"MD040": false,
77+
"MD041": {
78+
"front_matter_title": ""
9179
},
92-
"proper-names": {
80+
"MD042": true,
81+
"MD043": false,
82+
"MD044": {
9383
"code_blocks": false,
9484
"names": [
9585
"PowerShell",
@@ -109,24 +99,46 @@
10999
"Newtonsoft"
110100
]
111101
},
112-
"required-headers": false,
113-
"single-h1": {
114-
"front_matter_title": "",
115-
"level": 1
102+
"MD045": true,
103+
"MD046": {
104+
"style": "fenced"
116105
},
117-
"single-trailing-newline": true,
118-
"strong-style": {
119-
"style": "asterisk"
106+
"MD047": true,
107+
"MD048": {
108+
"style": "backtick"
120109
},
121-
"ul-indent": {
122-
"indent": 2,
123-
"start_indented": false
110+
"MD049": {
111+
"style": "underscore"
124112
},
125-
"ul-start-left": true,
126-
"ul-style": {
127-
"style": "dash"
113+
"MD050": {
114+
"style": "asterisk"
115+
},
116+
"MD051": true,
117+
"MD052": true,
118+
"MD053": true,
119+
"MD054": {
120+
"autolink": false,
121+
"collapsed": false,
122+
"full": true,
123+
"inline": true,
124+
"shortcut": false,
125+
"url_inline": true
126+
},
127+
"MD055": {
128+
"style": "leading_and_trailing"
129+
},
130+
"MD056": true,
131+
"MD058": true,
132+
"MD059": {
133+
"prohibited_texts": [
134+
"click here",
135+
"here",
136+
"link",
137+
"more"
138+
]
128139
},
129-
"link-fragments": true,
130-
"reference-links-images": true,
131-
"link-image-reference-definitions": true
132-
}
140+
"MD060": {
141+
"aligned_delimiter": false,
142+
"style": "any"
143+
}
144+
}

.markdownlint.yaml

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,11 @@
1-
docsmd.alert: true
2-
docsmd.codesnippet: true
3-
docsmd.column: true
4-
docsmd.image: true
5-
docsmd.moniker: true
6-
docsmd.no-loc: true
7-
docsmd.row: true
8-
docsmd.securelinks: true
9-
docsmd.syntax: true
10-
docsmd.video: true
11-
docsmd.xref: true
12-
docsmd.zone: true
13-
141
MD001: true # header-increment
15-
# MD002 # first-header-h1 - Superceded by MD041
2+
# MD002 # first-header-h1 - Superseded by MD041
163
MD003: # header-style
174
style: atx
185
MD004: # ul-style
196
style: dash
207
MD005: true # list-indent
21-
# MD006 # ul-start-left - Superceded by MD007's start_indented option
8+
# MD006 # ul-start-left - Superseded by MD007
229
MD007: # ul-indent
2310
indent: 2
2411
start_indented: false
@@ -115,3 +102,20 @@ MD050: # strong-style
115102
MD051: true # link-fragments
116103
MD052: true # reference-links-images
117104
MD053: true # link-image-reference-definitions
105+
MD054: # link-image-style
106+
autolink: false # Allow autolinks (default true)
107+
collapsed: false # Allow collapsed reference links and images (default true)
108+
full: true # Allow full reference links and images (default true)
109+
inline: true # Allow inline links and images (default true)
110+
shortcut: false # Allow shortcut reference links and images (default true)
111+
url_inline: true # Allow URLs as inline links (default true)
112+
MD055: # table-pipe-style
113+
style: leading_and_trailing
114+
MD056: true # table-column-count
115+
# MD057: # not used by linter - never defined
116+
MD058: true # blanks-around-tables
117+
MD059: # descriptive-link-text
118+
prohibited_texts: ["click here","here","link","more"]
119+
MD060: # table-column-style
120+
aligned_delimiter: false
121+
style: any

0 commit comments

Comments
 (0)