-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
.markdownlint.yaml
150 lines (128 loc) · 4.94 KB
/
.markdownlint.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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# Configuration file for markdownlint
# Default state for all rules
default: true
# MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md003.md
heading-style:
# Heading style
style: 'atx'
# MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md004.md
ul-style:
# List style
style: 'asterisk'
# MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md007.md
ul-indent:
# Spaces for indent
indent: 4
# Whether to indent the first level of the list
start_indented: false
# Spaces for first level indent (when start_indented is set)
start_indent: 4
# MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md
no-trailing-spaces:
# Spaces for line break
br_spaces: 0
# Allow spaces for empty lines in list items
list_item_empty_lines: false
# Include unnecessary breaks
strict: true
# MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md010.md
no-hard-tabs:
# Include code blocks
code_blocks: true
# Fenced code languages to ignore
ignore_code_languages: []
# Number of spaces for each hard tab
spaces_per_tab: 4
# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md012.md
no-multiple-blanks:
# Consecutive blank lines
maximum: 4
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
line-length: false
# MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md022.md
blanks-around-headings:
# Blank lines above heading
lines_above: 2
# Blank lines below heading
lines_below: 1
# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md024.md
no-duplicate-heading:
# Only check sibling headings
siblings_only: true
# MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md029.md
ol-prefix:
# List style
style: 'one_or_ordered'
# MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md031.md
blanks-around-fences:
# Include list items
list_items: false
# MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md035.md
hr-style:
# Horizontal rule style
style: '---'
# MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md040.md
fenced-code-language:
# List of languages
allowed_languages: []
# Require language only
language_only: false
# MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md041.md
first-line-heading: false # Disabled due to FP on files with ref target labels
# MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md044.md
MD044:
# List of proper names
names:
- 'CAM Gerlach'
- 'GitHub'
- 'github.com'
- 'Python'
- 'python.org'
- 'reStructuredText'
- 'Sphinx'
- 'sphinx-doc.org'
- 'Spyder'
- 'Spyder-IDE'
- 'spyder-ide.org'
- 'Spyder-API-Docs'
- 'Spyder-Docs'
- 'Spyder-Website'
- 'Spyder-API-Docs'
# Include code blocks
code_blocks: false
# Include HTML elements
html_elements: false
# MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md046.md
code-block-style:
# Block style
style: 'fenced'
# MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md048.md
code-fence-style:
# Code fence style
style: 'backtick'
# MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md049.md
emphasis-style:
# Emphasis style
style: 'asterisk'
# MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md050.md
strong-style:
# Strong style
style: 'asterisk'
# MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md054.md
link-image-style:
# Allow autolinks
autolink: false
# Allow inline links and images
inline: true
# Allow full reference links and images
full: true
# Allow collapsed reference links and images
collapsed: false
# Allow shortcut reference links and images
shortcut: false
# Allow URLs as inline links
url_inline: false
# MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md055.md
table-pipe-style:
# Table pipe style
style: 'leading_and_trailing'