-
Notifications
You must be signed in to change notification settings - Fork 17
Expand file tree
/
Copy path.markdownlint.yml
More file actions
54 lines (46 loc) · 1.78 KB
/
.markdownlint.yml
File metadata and controls
54 lines (46 loc) · 1.78 KB
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
# See full set of rules:
# - https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
# - https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
#
# Note: Different rules could be specified for different subdirectories. Put similar rules
# in a subdirectory and adjust them.
# MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md004.md
MD004:
# List style
style: sublist
MD010:
spaces_per_tab: 4
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md
MD013:
# Number of characters
line_length: 80
# Number of characters for headings
heading_line_length: 80
# Ignore line length in code blocks
code_blocks: false
# Ignore line length in tables
tables: false
# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md024.md
MD024:
# Only check sibling headings
siblings_only: true
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md
MD033:
# Allowed elements
allowed_elements:
- version
- img
- a
# MD041/First line, top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md041.md
MD041:
# Allow content before first heading
allow_preamble: true
# MD049/Emphasis style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md049.md
MD049:
# Emphasis(Italic) within a word is restricted to `asterisk` in order to avoid unwanted emphasis
# for words containing internal underscores.
style: asterisk
# MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md050.md
MD050:
# Strong(Bold) style
style: asterisk