forked from PHPCSStandards/PHP_CodeSniffer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.markdownlint-cli2.yaml
109 lines (91 loc) · 3.07 KB
/
.markdownlint-cli2.yaml
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
#
# Configuration file for MarkdownLint-CLI2.
#
# Example file with all options:
# https://github.com/DavidAnson/markdownlint-cli2/blob/main/test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml
# Example file with all rules:
# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
#
# Define glob expressions to use (only valid at root).
globs:
- "**/*.md"
- ".github/**/*.md"
# Show found files on stdout (only valid at root)
showFound: true
# Define glob expressions to ignore.
ignores:
- "node_modules/"
- "vendor/"
# Disable inline config comments.
noInlineConfig: true
# Disable progress on stdout (only valid at root).
noProgress: false
# Adjust the configuration for some built-in rules.
# For full information on the options and defaults, see:
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
config:
######################
# Disable a few rules.
######################
# MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines.
MD031: false
# MD032/blanks-around-lists - Lists should be surrounded by blank lines.
MD032: false
##############################
# Customize a few other rules.
##############################
# MD003/heading-style/header-style - Heading style.
MD003:
# Heading style - Always use hashes.
style: "atx"
# MD007/ul-indent - Unordered list indentation.
MD007:
indent: 4
# Whether to indent the first level of the list.
start_indented: false
# MD012/no-multiple-blanks - Multiple consecutive blank lines.
MD012:
maximum: 2
# MD013/line-length - Line length.
MD013:
# Number of characters. No need for being too fussy.
line_length: 1000
# Number of characters for headings.
heading_line_length: 100
# Number of characters for code blocks.
code_block_line_length: 100
# Stern length checking (applies to tables, code blocks etc which have their own max line length).
stern: true
# MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md022.md
MD022:
# Blank lines above heading
lines_above: [2, 1, 1, 1, 1]
# Blank lines below heading
lines_below: [1, 1, -1, -1, -1]
# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content.
MD024:
# Only check sibling headings.
siblings_only: true
# MD033/no-inline-html - Inline HTML.
MD033:
# Allowed elements.
allowed_elements:
- div
# MD044/proper-names - Proper names should have the correct capitalization.
MD044:
# List of proper names.
names: ["PHP", "PHP_CodeSniffer", "CodeSniffer", "PHPUnit", "Xdebug"]
# Include code blocks.
code_blocks: false
# MD046/code-block-style - Code block style
MD046:
style: "fenced"
# MD048/code-fence-style - Code fence style
MD048:
style: "backtick"
# MD049/emphasis-style - Emphasis style should be consistent
MD049:
style: "underscore"
# MD050/strong-style - Strong style should be consistent
MD050:
style: "asterisk"