diff options
author | Marcel Amirault <mamirault@gitlab.com> | 2019-07-12 12:25:44 +0900 |
---|---|---|
committer | Marcel Amirault <mamirault@gitlab.com> | 2019-07-12 12:25:44 +0900 |
commit | e8314736ef093acb05a123d2980f8fd363c1be87 (patch) | |
tree | 3707566ae4a96bb0d6a53e306be8d865fb93c876 | |
parent | 9f0d13b947ab764208193edc41eb59a7a2d0158d (diff) | |
download | gitlab-ce-docs-markdown-lint-update.tar.gz |
Update note in .mdlrc filesdocs-markdown-lint-update
-rw-r--r-- | .mdlrc | 2 | ||||
-rw-r--r-- | .mdlrc.style | 50 |
2 files changed, 10 insertions, 42 deletions
@@ -1,4 +1,4 @@ -# This is the options file for markdownlint, run by /.gitlab/ci/docs.gitlab-ci.yml +# This is the options file for mdl, configured in .gitlab/ci/docs.gitlab-ci.yml, # and related to the style file ./mdlrc.style # See https://github.com/markdownlint/markdownlint/blob/master/docs/configuration.md diff --git a/.mdlrc.style b/.mdlrc.style index a2e1758b3eb..0ca3611df0b 100644 --- a/.mdlrc.style +++ b/.mdlrc.style @@ -1,43 +1,16 @@ -# This is the style file for markdownlint, run by /.gitlab/ci/docs.gitlab-ci.yml +# 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 details information on the rules and styles. +# for more detailed information on the rules and styles. -rule "MD001" # header levels increment by 1 -rule "MD003", :style => :atx # header style - atx -rule "MD011" # alert on reversed link syntax -rule "MD023" # headers must start at the beginning of the line -rule "MD032" # lists should be surrounded by line -rule 'MD034' # Bare URL used -rule "MD037" # Spaces inside emphasis markers - -# Should be enabled when test passes for it: - -# rule "MD002" # first header should be level 1 -# rule "MD005" # don't allow inconsistent indentation for list items -# rule "MD006" # start bullets at beginning of line -# rule "MD007" # unordered list indentation should be 2 spaces -# rule "MD009" # trailing spaces not allowed -# rule "MD010" # hard tabs not allowed -# rule "MD012" # alert on multiple consecutive blank lines -# rule "MD018" # must have space after header style -# rule "MD019" # no multiple spaces after header style -# rule "MD022" # headers should be surrounded by blank lines -# rule "MD024", :allow_different_nesting => true # no multiple headers with same content -# rule "MD025" # only 1 level 1 header -# rule "MD026", :punctuation => '.,;:!' # no trailing punctuation in headers -# rule "MD027" # no multiple spaces after blockquote symbol -# rule "MD028" # no blank lines within blockquote -# rule "MD029", :style => :one # ordered list item prefix, should be ordered -# rule "MD030" # spaces after list markers -# rule "MD031" # fenced code blocks need line surrounding -# rule "MD035", :style => "---" # Horizontal rule style -# rule "MD036" # Emphasis used instead of a header -# rule "MD038" # Spaces inside code span elements -# rule "MD040" # Fenced code blocks should have a language specified -# rule "MD046" # Code block style -# rule "MD047" # Files should end with a single newline character +rule "MD001" +rule "MD003", :style => :atx +rule "MD011" +rule "MD023" +rule "MD032" +rule "MD034" +rule "MD037" # Should not be used currently: @@ -46,8 +19,3 @@ rule "MD037" # Spaces inside emphasis markers # rule "MD039" # Spaces inside link text # Crashes when link text has certain punctuation - -# rule "MD013" # line length should be no more than 80 characters -# rule "MD014" # dollars signs not before commands w/o showing output -# rule "MD033" # Inline HTML -# rule "MD041" # First line in file should be a top level header |