summaryrefslogtreecommitdiff
path: root/.mdlrc.style
diff options
context:
space:
mode:
authorMarcel Amirault <mamirault@gitlab.com>2019-07-15 01:42:24 +0000
committerEvan Read <eread@gitlab.com>2019-07-15 01:42:24 +0000
commit7f50358d1cc7fbb22dba031293566c454c68eb23 (patch)
tree50b246be65522126ef1833e7731ecd4a37e3a2f1 /.mdlrc.style
parent6f3a2b0b096489d07df7dfb8ffd963f45e84fce1 (diff)
downloadgitlab-ce-7f50358d1cc7fbb22dba031293566c454c68eb23.tar.gz
Update markdown lint style and option files
Add commented lines explaining the file, and including rules that should pass already, and commented out rules that can be added in the future, for reference.
Diffstat (limited to '.mdlrc.style')
-rw-r--r--.mdlrc.style22
1 files changed, 18 insertions, 4 deletions
diff --git a/.mdlrc.style b/.mdlrc.style
index 30abf03f462..0ca3611df0b 100644
--- a/.mdlrc.style
+++ b/.mdlrc.style
@@ -1,7 +1,21 @@
+# This is the style file for mdl, configured in .gitlab/ci/docs.gitlab-ci.yml,
+# and related to the options file ./mdlrc
+
# See https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
+# for more detailed information on the rules and styles.
+
+rule "MD001"
+rule "MD003", :style => :atx
+rule "MD011"
+rule "MD023"
+rule "MD032"
+rule "MD034"
+rule "MD037"
+
+# Should not be used currently:
-rule 'MD001'
+# rule "MD004", :style => :dash # unordered list style - dash
# False positives, see https://github.com/markdownlint/markdownlint/issues/261
-# rule 'MD004', style: :dash
-rule 'MD032'
-rule 'MD034'
+
+# rule "MD039" # Spaces inside link text
+# Crashes when link text has certain punctuation