-
Notifications
You must be signed in to change notification settings - Fork 9
/
.mdlstyle.rb
50 lines (38 loc) · 1.77 KB
/
.mdlstyle.rb
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
################################################################################
# Style file for markdownlint.
#
# https://github.com/markdownlint/markdownlint/blob/master/docs/configuration.md
#
# This file is referenced by the project `.mdlrc`.
################################################################################
#===============================================================================
# Start with all built-in rules.
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
all
#===============================================================================
# Override default parameters for some built-in rules.
# https://github.com/markdownlint/markdownlint/blob/master/docs/creating_styles.md#parameters
# Ignore line length in code blocks.
rule 'MD013', code_blocks: false
#===============================================================================
# Exclude the rules I disagree with.
# IMHO it's easier to read lists like:
# * outmost indent
# - one indent
# - second indent
# * Another major bullet
exclude_rule 'MD004' # Unordered list style
# I prefer two blank lines before each heading.
exclude_rule 'MD012' # Multiple consecutive blank lines
# Ignore line length check.
exclude_rule 'MD013' # Line length check
# I find it necessary to use '<br/>' to force line breaks.
exclude_rule 'MD033' # Inline HTML
# If a page is printed, it helps if the URL is viewable.
exclude_rule 'MD034' # Bare URL used
# I prefer to write some intro
exclude_rule 'MD041' # First line is a top level header
#===============================================================================
# Exclude rules for pragmatic reasons.
# Either disable this one or MD024 - Multiple headers with the same content.
exclude_rule 'MD036' # Emphasis used instead of a header