Skip to content

Commit b19299e

Browse files
committed
Add markdown linting configuration
1 parent 9493a80 commit b19299e

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed

.editorconfig

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# http://editorconfig.org
2+
# https://editorconfig-specification.readthedocs.io/en/latest/
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
end_of_line = lf
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
12+
[*.{py,ini,sh}]
13+
indent_style = space
14+
indent_size = 4
15+
16+
[*.{html,css,scss,json,yml,tpl,js,jsx}]
17+
indent_style = space
18+
indent_size = 2
19+
20+
[*.md]
21+
indent_style = space
22+
indent_size = 4
23+
tab_width = 4
24+
25+
[*.rst]
26+
indent_style = space
27+
indent_size = 3
28+
29+
[Makefile]
30+
indent_style = tab

.markdownlint.json

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"MD003": true,
3+
"MD004": false,
4+
"MD007": false,
5+
"MD013": {
6+
"tables": false,
7+
"code_blocks": false,
8+
"line_length": 88
9+
},
10+
"MD024": false,
11+
"MD026": false,
12+
"MD029": false,
13+
"MD034": true,
14+
"MD046": true,
15+
"code-block-style": {
16+
"style": "fenced"
17+
}
18+
}

.pre-commit-config.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,9 @@ repos:
1717
hooks:
1818
- id: flake8
1919
exclude: ^docs/|^examples/
20+
- repo: https://github.com/igorshubovych/markdownlint-cli
21+
rev: v0.31.1
22+
hooks:
23+
- id: markdownlint
24+
args: [-f]
25+
exclude: ^(.github|tests)

0 commit comments

Comments
 (0)