-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
.markdownlint.yml
67 lines (61 loc) · 2.42 KB
/
.markdownlint.yml
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
---
###########################
###########################
## Markdown Linter rules ##
###########################
###########################
# Linter rules doc:
# - https://github.com/DavidAnson/markdownlint
#
# Note:
# To comment out a single error:
# <!-- markdownlint-disable -->
# any violations you want
# <!-- markdownlint-restore -->
#
# To run the linter locally:
# 1. install the npm package:
# `npm install -g markdownlint-cli`
# 2. Then run it in the root of the repo with
# `markdownlint -c .markdownlint.yml ./*.md`
# Example markdownlint YAML configuration with all properties set to their default value
# Add config from DavidAnsons Markdownlint library config https://github.com/DavidAnson/vscode-markdownlint
# Default state for all rules
default: true
line_length: false
# Path to configuration file to extend
extends: null
###############
# Rules by id #
###############
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md004
MD004: false # Unordered list style
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md007
MD007:
indent: 2 # Unordered list indentation
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md013
MD013:
line_length: 400 # Line length 80 is far to short
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md024
MD024: false # Allow multiple headings with same content
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md026
MD026:
punctuation: '.,;:!。，；:' # List of not allowed
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md029
MD029: false # Ordered list item prefix
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md033
MD033: false # Allow inline HTML
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md034
MD034: false # Allow Bare URL use
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md036
MD036: false # Emphasis used instead of a heading
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md040
MD040: false # Allow ``` blocks in md files with no language specified
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md041
MD041: false # First line in a file should be a top-level heading
#https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md042
MD042: false # Allow empty links
#################
# Rules by tags #
#################
blank_lines: false # No errors on blank lines