forked from Simulation-Software-Engineering/Lecture-Material
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.mdl.rb
44 lines (38 loc) · 1.45 KB
/
.mdl.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
# Enable all rules by default
all
######################################################
# Deactivated/excluded rules
######################################################
# Allow first header to not be a top level header
# since top-level is set by metadata
exclude_rule 'MD002'
# Allow hard tabs such that they can be used in code blocks
# as needed for Makefiles
exclude_rule 'MD010'
# First line in file does not have to be a top level header
# since top-level is set by metadata
exclude_rule 'MD041'
# Allow multiple consecutive blank lines
exclude_rule 'MD012'
# Allow raw HTML to include videos, for example.
exclude_rule 'MD033'
# Bare URL used rule seems buggy (false positives), therefore excluded
exclude_rule 'MD034'
# Allow code blocks without a language specified
exclude_rule 'MD040'
######################################################
# Adapted rules
######################################################
# Enforce dashes as symvol in lists
rule 'MD004', :style => :dash
# Enforce indent with four space characters. This helps with
# mixing ordered and unordered lists
rule 'MD007', :indent => 4
# Extend line length for text.
# This will complain for overly wide tables and code blocks.
rule 'MD013', :line_length => 99999
# Nested lists should be indented with four spaces.
# Modification: Question marks should be allowed
rule 'MD026', :punctuation => '.,;:!'
# Ordered lists must have prefix that increases in order
rule 'MD029', :style => :ordered