mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-21 21:30:47 +02:00
Add note to all rules in Rules.md that can be fixed automatically by tooling.
This commit is contained in:
parent
6ac5fa52a6
commit
53a0ba18d8
1 changed files with 52 additions and 0 deletions
52
doc/Rules.md
52
doc/Rules.md
|
@ -186,6 +186,8 @@ Tags: bullet, ul, indentation
|
|||
|
||||
Aliases: list-indent
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when list items are parsed as being at the same level,
|
||||
but don't have the same indentation:
|
||||
|
||||
|
@ -240,6 +242,8 @@ Tags: bullet, ul, indentation
|
|||
|
||||
Aliases: ul-start-left
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when top level lists don't start at the beginning of a
|
||||
line:
|
||||
|
||||
|
@ -287,6 +291,8 @@ Aliases: ul-indent
|
|||
|
||||
Parameters: indent, start_indented (number; default 2, boolean; default false)
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when list items are not indented by the configured
|
||||
number of spaces (default: 2).
|
||||
|
||||
|
@ -330,6 +336,8 @@ Aliases: no-trailing-spaces
|
|||
|
||||
Parameters: br_spaces, list_item_empty_lines, strict (number; default 2, boolean; default false, boolean; default false)
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered on any lines that end with unexpected whitespace. To fix this,
|
||||
remove the trailing space from the end of the line.
|
||||
|
||||
|
@ -372,6 +380,8 @@ Aliases: no-hard-tabs
|
|||
|
||||
Parameters: code_blocks (boolean; default true)
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered by any lines that contain hard tab characters instead
|
||||
of using spaces for indentation. To fix this, replace any hard tab characters
|
||||
with spaces instead.
|
||||
|
@ -407,6 +417,8 @@ Tags: links
|
|||
|
||||
Aliases: no-reversed-links
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when text that appears to be a link is encountered, but
|
||||
where the syntax appears to have been reversed (the `[]` and `()` are
|
||||
reversed):
|
||||
|
@ -439,6 +451,8 @@ Aliases: no-multiple-blanks
|
|||
|
||||
Parameters: maximum (number; default 1)
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when there are multiple consecutive blank lines in the
|
||||
document:
|
||||
|
||||
|
@ -521,6 +535,8 @@ Tags: code
|
|||
|
||||
Aliases: commands-show-output
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when there are code blocks showing shell commands to be
|
||||
typed, and *all* of the shell commands are preceded by dollar signs ($):
|
||||
|
||||
|
@ -572,6 +588,8 @@ Tags: headings, headers, atx, spaces
|
|||
|
||||
Aliases: no-missing-space-atx
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when spaces are missing after the hash characters
|
||||
in an atx style heading:
|
||||
|
||||
|
@ -600,6 +618,8 @@ Tags: headings, headers, atx, spaces
|
|||
|
||||
Aliases: no-multiple-space-atx
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when more than one space is used to separate the
|
||||
heading text from the hash characters in an atx style heading:
|
||||
|
||||
|
@ -629,6 +649,8 @@ Tags: headings, headers, atx_closed, spaces
|
|||
|
||||
Aliases: no-missing-space-closed-atx
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when spaces are missing inside the hash characters
|
||||
in a closed atx style heading:
|
||||
|
||||
|
@ -659,6 +681,8 @@ Tags: headings, headers, atx_closed, spaces
|
|||
|
||||
Aliases: no-multiple-space-closed-atx
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when more than one space is used to separate the
|
||||
heading text from the hash characters in a closed atx style heading:
|
||||
|
||||
|
@ -693,6 +717,8 @@ Aliases: blanks-around-headings, blanks-around-headers
|
|||
|
||||
Parameters: lines_above, lines_below (number; default 1)
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when headings (any style) are either not preceded or not
|
||||
followed by at least one blank line:
|
||||
|
||||
|
@ -735,6 +761,8 @@ Tags: headings, headers, spaces
|
|||
|
||||
Aliases: heading-start-left, header-start-left
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when a heading is indented by one or more spaces:
|
||||
|
||||
```markdown
|
||||
|
@ -857,6 +885,8 @@ Aliases: no-trailing-punctuation
|
|||
|
||||
Parameters: punctuation (string; default ".,;:!?。,;:!?")
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered on any heading that has one of the specified normal or
|
||||
full-width punctuation characters as the last character in the line:
|
||||
|
||||
|
@ -887,6 +917,8 @@ Tags: blockquote, whitespace, indentation
|
|||
|
||||
Aliases: no-multiple-space-blockquote
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when blockquotes have more than one space after the
|
||||
blockquote (`>`) symbol:
|
||||
|
||||
|
@ -912,6 +944,8 @@ Tags: blockquote, whitespace
|
|||
|
||||
Aliases: no-blanks-blockquote
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when two blockquote blocks are separated by nothing
|
||||
except for a blank line:
|
||||
|
||||
|
@ -1048,6 +1082,8 @@ Aliases: list-marker-space
|
|||
|
||||
Parameters: ul_single, ol_single, ul_multi, ol_multi (number; default 1)
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule checks for the number of spaces between a list marker (e.g. '`-`',
|
||||
'`*`', '`+`' or '`1.`') and the text of the list item.
|
||||
|
||||
|
@ -1121,6 +1157,8 @@ Aliases: blanks-around-fences
|
|||
|
||||
Parameters: list_items (boolean; default true)
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when fenced code blocks are either not preceded or not
|
||||
followed by a blank line:
|
||||
|
||||
|
@ -1168,6 +1206,8 @@ Tags: bullet, ul, ol, blank_lines
|
|||
|
||||
Aliases: blanks-around-lists
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when lists (of any kind) are either not preceded or not
|
||||
followed by a blank line:
|
||||
|
||||
|
@ -1235,6 +1275,8 @@ Tags: links, url
|
|||
|
||||
Aliases: no-bare-urls
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered whenever a URL is given that isn't surrounded by angle
|
||||
brackets:
|
||||
|
||||
|
@ -1370,6 +1412,8 @@ Tags: whitespace, emphasis
|
|||
|
||||
Aliases: no-space-in-emphasis
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when emphasis markers (bold, italic) are used, but they
|
||||
have spaces between the markers and the text:
|
||||
|
||||
|
@ -1408,6 +1452,8 @@ Tags: whitespace, code
|
|||
|
||||
Aliases: no-space-in-code
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered for code span elements that have spaces adjacent to the
|
||||
backticks:
|
||||
|
||||
|
@ -1447,6 +1493,8 @@ Tags: whitespace, links
|
|||
|
||||
Aliases: no-space-in-links
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered on links that have spaces surrounding the link text:
|
||||
|
||||
```markdown
|
||||
|
@ -1639,6 +1687,8 @@ Aliases: proper-names
|
|||
|
||||
Parameters: names, code_blocks (string array; default `null`, boolean; default `true`)
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when any of the strings in the `names` array do not have
|
||||
the specified capitalization. It can be used to enforce a standard letter case
|
||||
for the names of projects and products.
|
||||
|
@ -1732,6 +1782,8 @@ Tags: blank_lines
|
|||
|
||||
Aliases: single-trailing-newline
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when there is not a single newline character at the end of a file.
|
||||
|
||||
Example that triggers the rule:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue