Skip to content

Commit 633dcee

Browse files
(AB-5074) Update markdownlint config to yaml (#97)
This change replaces the JSON configuration for markdownlint in the repository with YAML files, which can be commented and are easier to author and maintain. - Related to AB#5074
1 parent 9bcddad commit 633dcee

File tree

8 files changed

+145
-160
lines changed

8 files changed

+145
-160
lines changed

.markdownlint.json

Lines changed: 0 additions & 132 deletions
This file was deleted.

.markdownlint.yaml

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
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+
14+
MD001: true # header-increment
15+
# MD002 # first-header-h1 - Superceded by MD041
16+
MD003: # header-style
17+
style: atx
18+
MD004: # ul-style
19+
style: dash
20+
MD005: true # list-indent
21+
# MD006 # ul-start-left - Superceded by MD007's start_indented option
22+
MD007: # ul-indent
23+
indent: 2
24+
start_indented: false
25+
# MD008 # Removed from linter; used to specify indentation for ul
26+
MD009: # no-trailing-spaces
27+
br_spaces: 2
28+
strict: true
29+
MD010: true # no-hard-tabs
30+
MD011: true # no-reversed-links
31+
MD012: true # no-multiple-blanks
32+
MD013: # line-length
33+
code_block_line_length: 90
34+
code_blocks: true
35+
heading_line_length: 100
36+
headings: true
37+
line_length: 100
38+
stern: true
39+
tables: false
40+
MD014: true # commands-show-output
41+
# MD015 # "Use of non-atx style headers" - Removed from linter, replaced by MD003
42+
# MD016 # "Use of non-closed-atx style headers" - Removed from linter, replaced by MD003
43+
# MD017 # "Use of non-setext style headers" - Removed from linter, replaced by MD003
44+
MD018: true # no-missing-space-atx
45+
MD019: true # no-multiple-space-atx
46+
MD020: true # no-missing-space-closed-atx
47+
MD021: true # no-multiple-space-closed-atx
48+
MD022: true # blanks-around-headers
49+
MD023: true # header-start-left
50+
MD024: # no-duplicate-header
51+
siblings_only: true
52+
MD025: # single-h1
53+
front_matter_title: ''
54+
level: 1
55+
MD026: # no-trailing-punctuation
56+
punctuation: '.,;:!。,;:!?'
57+
MD027: true # no-multiple-space-blockquote
58+
MD028: true # no-blanks-blockquote
59+
MD029: # ol-prefix
60+
style: one
61+
MD030: true # list-marker-space
62+
MD031: true # blanks-around-fences
63+
MD032: true # blanks-around-lists
64+
MD033: # no-inline-html
65+
allowed_elements:
66+
- a
67+
- br
68+
- code
69+
- kbd
70+
- li
71+
- properties
72+
- sup
73+
- tags
74+
- ul
75+
MD034: true # no-bare-urls
76+
MD035: # hr-style
77+
style: '---'
78+
MD036: true # no-emphasis-as-header
79+
MD037: true # no-space-in-emphasis
80+
MD038: true # no-space-in-code
81+
MD039: true # no-space-in-links
82+
MD040: false # fenced-code-language
83+
MD041: # first-line-h1
84+
front_matter_title: ''
85+
MD042: true # no-empty-links
86+
MD043: false # required-headers
87+
MD044: # proper-names
88+
code_blocks: false
89+
names:
90+
- PowerShell
91+
- IntelliSense
92+
- Authenticode
93+
- CentOS
94+
- Contoso
95+
- CoreOS
96+
- Debian
97+
- Ubuntu
98+
- openSUSE
99+
- RHEL
100+
- JavaScript
101+
- .NET
102+
- NuGet
103+
- VS Code
104+
- Newtonsoft
105+
MD045: true # no-alt-text
106+
MD046: # code-block-style
107+
style: fenced
108+
MD047: true # single-trailing-newline
109+
MD048: # code-fence-style
110+
style: backtick
111+
MD049: # emphasis-style
112+
style: underscore
113+
MD050: # strong-style
114+
style: asterisk
115+
MD051: true # link-fragments
116+
MD052: true # reference-links-images
117+
MD053: true # link-image-reference-definitions

reference/docs-conceptual/PSScriptAnalyzer/Rules/.markdownlint.json

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# PSScriptAnalyzer rules declare their severity level as bold text after the H1.
2+
# This violates MD036, which is good practice for most other documentation.
3+
extends: ../../../../.markdownlint.yaml
4+
MD036: false # no-emphasis-as-heading

reference/ps-modules/Microsoft.PowerShell.Crescendo/About/.markdownlint.json

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# About topics have different line length requirements; their text is
2+
# automatically wrapped at 80 characters, so it's preferable to control
3+
# the wrapping here instead.
4+
extends: ../../../../.markdownlint.yaml
5+
MD013: # line-length
6+
code_block_line_length: 74
7+
code_blocks: true
8+
heading_line_length: 79
9+
headings: true
10+
line_length: 79
11+
stern: true
12+
tables: false

reference/ps-modules/PlatyPS/About/.markdownlint.json

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# About topics have different line length requirements; their text is
2+
# automatically wrapped at 80 characters, so it's preferable to control
3+
# the wrapping here instead.
4+
extends: ../../../../.markdownlint.yaml
5+
MD013: # line-length
6+
code_block_line_length: 74
7+
code_blocks: true
8+
heading_line_length: 79
9+
headings: true
10+
line_length: 79
11+
stern: true
12+
tables: false

0 commit comments

Comments
 (0)