mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-12-23 09:20:12 +01:00
Change "header" to "heading" across the library
This should be backward compatible, as all "header" aliases are still available, though documented as discouraged for future use.
This commit is contained in:
Milos Levacic
David Anson
parent
e938f421a9
commit
45424cf459
148 changed files with 861 additions and 699 deletions
66
README.md
66
README.md
|
|
@ -46,9 +46,9 @@ playground for learning and exploring.
|
|||
|
||||
## Rules / Aliases
|
||||
|
||||
* **[MD001](doc/Rules.md#md001)** *header-increment* - Header levels should only increment by one level at a time
|
||||
* **[MD002](doc/Rules.md#md002)** *first-header-h1* - First header should be a top level header
|
||||
* **[MD003](doc/Rules.md#md003)** *header-style* - Header style
|
||||
* **[MD001](doc/Rules.md#md001)** *heading-increment, header-increment* - Heading levels should only increment by one level at a time
|
||||
* **[MD002](doc/Rules.md#md002)** *first-heading-h1, first-header-h1* - First heading should be a top level heading
|
||||
* **[MD003](doc/Rules.md#md003)** *heading-style, header-style* - Heading style
|
||||
* **[MD004](doc/Rules.md#md004)** *ul-style* - Unordered list style
|
||||
* **[MD005](doc/Rules.md#md005)** *list-indent* - Inconsistent indentation for list items at the same level
|
||||
* **[MD006](doc/Rules.md#md006)** *ul-start-left* - Consider starting bulleted lists at the beginning of the line
|
||||
|
|
@ -59,15 +59,15 @@ playground for learning and exploring.
|
|||
* **[MD012](doc/Rules.md#md012)** *no-multiple-blanks* - Multiple consecutive blank lines
|
||||
* **[MD013](doc/Rules.md#md013)** *line-length* - Line length
|
||||
* **[MD014](doc/Rules.md#md014)** *commands-show-output* - Dollar signs used before commands without showing output
|
||||
* **[MD018](doc/Rules.md#md018)** *no-missing-space-atx* - No space after hash on atx style header
|
||||
* **[MD019](doc/Rules.md#md019)** *no-multiple-space-atx* - Multiple spaces after hash on atx style header
|
||||
* **[MD020](doc/Rules.md#md020)** *no-missing-space-closed-atx* - No space inside hashes on closed atx style header
|
||||
* **[MD021](doc/Rules.md#md021)** *no-multiple-space-closed-atx* - Multiple spaces inside hashes on closed atx style header
|
||||
* **[MD022](doc/Rules.md#md022)** *blanks-around-headers* - Headers should be surrounded by blank lines
|
||||
* **[MD023](doc/Rules.md#md023)** *header-start-left* - Headers must start at the beginning of the line
|
||||
* **[MD024](doc/Rules.md#md024)** *no-duplicate-header* - Multiple headers with the same content
|
||||
* **[MD025](doc/Rules.md#md025)** *single-h1* - Multiple top level headers in the same document
|
||||
* **[MD026](doc/Rules.md#md026)** *no-trailing-punctuation* - Trailing punctuation in header
|
||||
* **[MD018](doc/Rules.md#md018)** *no-missing-space-atx* - No space after hash on atx style heading
|
||||
* **[MD019](doc/Rules.md#md019)** *no-multiple-space-atx* - Multiple spaces after hash on atx style heading
|
||||
* **[MD020](doc/Rules.md#md020)** *no-missing-space-closed-atx* - No space inside hashes on closed atx style heading
|
||||
* **[MD021](doc/Rules.md#md021)** *no-multiple-space-closed-atx* - Multiple spaces inside hashes on closed atx style heading
|
||||
* **[MD022](doc/Rules.md#md022)** *blanks-around-headings, blanks-around-headers* - Headings should be surrounded by blank lines
|
||||
* **[MD023](doc/Rules.md#md023)** *heading-start-left, header-start-left* - Headings must start at the beginning of the line
|
||||
* **[MD024](doc/Rules.md#md024)** *no-duplicate-heading, no-duplicate-header* - Multiple headings with the same content
|
||||
* **[MD025](doc/Rules.md#md025)** *single-h1* - Multiple top level headings in the same document
|
||||
* **[MD026](doc/Rules.md#md026)** *no-trailing-punctuation* - Trailing punctuation in heading
|
||||
* **[MD027](doc/Rules.md#md027)** *no-multiple-space-blockquote* - Multiple spaces after blockquote symbol
|
||||
* **[MD028](doc/Rules.md#md028)** *no-blanks-blockquote* - Blank line inside blockquote
|
||||
* **[MD029](doc/Rules.md#md029)** *ol-prefix* - Ordered list item prefix
|
||||
|
|
@ -77,19 +77,23 @@ playground for learning and exploring.
|
|||
* **[MD033](doc/Rules.md#md033)** *no-inline-html* - Inline HTML
|
||||
* **[MD034](doc/Rules.md#md034)** *no-bare-urls* - Bare URL used
|
||||
* **[MD035](doc/Rules.md#md035)** *hr-style* - Horizontal rule style
|
||||
* **[MD036](doc/Rules.md#md036)** *no-emphasis-as-header* - Emphasis used instead of a header
|
||||
* **[MD036](doc/Rules.md#md036)** *no-emphasis-as-heading, no-emphasis-as-header* - Emphasis used instead of a heading
|
||||
* **[MD037](doc/Rules.md#md037)** *no-space-in-emphasis* - Spaces inside emphasis markers
|
||||
* **[MD038](doc/Rules.md#md038)** *no-space-in-code* - Spaces inside code span elements
|
||||
* **[MD039](doc/Rules.md#md039)** *no-space-in-links* - Spaces inside link text
|
||||
* **[MD040](doc/Rules.md#md040)** *fenced-code-language* - Fenced code blocks should have a language specified
|
||||
* **[MD041](doc/Rules.md#md041)** *first-line-h1* - First line in file should be a top level header
|
||||
* **[MD041](doc/Rules.md#md041)** *first-line-h1* - First line in file should be a top level heading
|
||||
* **[MD042](doc/Rules.md#md042)** *no-empty-links* - No empty links
|
||||
* **[MD043](doc/Rules.md#md043)** *required-headers* - Required header structure
|
||||
* **[MD043](doc/Rules.md#md043)** *required-headings, required-headers* - Required heading structure
|
||||
* **[MD044](doc/Rules.md#md044)** *proper-names* - Proper names should have the correct capitalization
|
||||
* **[MD045](doc/Rules.md#md045)** *no-alt-text* - Images should have alternate text (alt text)
|
||||
|
||||
See [Rules.md](doc/Rules.md) for more details.
|
||||
|
||||
> All rules with `heading` as part of their name are also available as `header`
|
||||
> aliases, e.g. `heading-increment` is also available as `header-increment`.
|
||||
> This is provided for backward compatibility, though its usage is discouraged.
|
||||
|
||||
## Tags
|
||||
|
||||
* **accessibility** - MD045
|
||||
|
|
@ -101,6 +105,8 @@ See [Rules.md](doc/Rules.md) for more details.
|
|||
* **code** - MD014, MD031, MD038, MD040
|
||||
* **emphasis** - MD036, MD037
|
||||
* **hard_tab** - MD010
|
||||
* **headings** - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023,
|
||||
MD024, MD025, MD026, MD036, MD041, MD043
|
||||
* **headers** - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023,
|
||||
MD024, MD025, MD026, MD036, MD041, MD043
|
||||
* **hr** - MD035
|
||||
|
|
@ -473,13 +479,13 @@ Output:
|
|||
|
||||
```text
|
||||
bad.string: 3: MD010/no-hard-tabs Hard tabs [Column: 19]
|
||||
bad.string: 1: MD018/no-missing-space-atx No space after hash on atx style header [Context: "#bad.string"]
|
||||
bad.string: 3: MD018/no-missing-space-atx No space after hash on atx style header [Context: "#This string fails some rules."]
|
||||
bad.string: 1: MD041/first-line-h1 First line in file should be a top level header [Context: "#bad.string"]
|
||||
bad.string: 1: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#bad.string"]
|
||||
bad.string: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This string fails some rules."]
|
||||
bad.string: 1: MD041/first-line-h1 First line in file should be a top level heading [Context: "#bad.string"]
|
||||
bad.md: 3: MD010/no-hard-tabs Hard tabs [Column: 17]
|
||||
bad.md: 1: MD018/no-missing-space-atx No space after hash on atx style header [Context: "#bad.md"]
|
||||
bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style header [Context: "#This file fails some rules."]
|
||||
bad.md: 1: MD041/first-line-h1 First line in file should be a top level header [Context: "#bad.md"]
|
||||
bad.md: 1: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#bad.md"]
|
||||
bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This file fails some rules."]
|
||||
bad.md: 1: MD041/first-line-h1 First line in file should be a top level heading [Context: "#bad.md"]
|
||||
```
|
||||
|
||||
Or invoke `markdownlint.sync` for a synchronous call:
|
||||
|
|
@ -513,19 +519,19 @@ Output:
|
|||
"errorRange": [ 17, 1 ] },
|
||||
{ "lineNumber": 1,
|
||||
"ruleNames": [ "MD018", "no-missing-space-atx" ],
|
||||
"ruleDescription": "No space after hash on atx style header",
|
||||
"ruleDescription": "No space after hash on atx style heading",
|
||||
"errorDetail": null,
|
||||
"errorContext": "#bad.md",
|
||||
"errorRange": [ 1, 2 ] },
|
||||
{ "lineNumber": 3,
|
||||
"ruleNames": [ "MD018", "no-missing-space-atx" ],
|
||||
"ruleDescription": "No space after hash on atx style header",
|
||||
"ruleDescription": "No space after hash on atx style heading",
|
||||
"errorDetail": null,
|
||||
"errorContext": "#This file fails\tsome rules.",
|
||||
"errorRange": [ 1, 2 ] },
|
||||
{ "lineNumber": 1,
|
||||
"ruleNames": [ "MD041", "first-line-h1" ],
|
||||
"ruleDescription": "First line in file should be a top level header",
|
||||
"ruleDescription": "First line in file should be a top level heading",
|
||||
"errorDetail": null,
|
||||
"errorContext": "#bad.md",
|
||||
"errorRange": null }
|
||||
|
|
@ -561,9 +567,9 @@ Output:
|
|||
```text
|
||||
[00:00:00] Starting 'markdownlint'...
|
||||
bad.md: 3: MD010/no-hard-tabs Hard tabs [Column: 17]
|
||||
bad.md: 1: MD018/no-missing-space-atx No space after hash on atx style header [Context: "#bad.md"]
|
||||
bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style header [Context: "#This file fails some rules."]
|
||||
bad.md: 1: MD041/first-line-h1 First line in file should be a top level header [Context: "#bad.md"]
|
||||
bad.md: 1: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#bad.md"]
|
||||
bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This file fails some rules."]
|
||||
bad.md: 1: MD041/first-line-h1 First line in file should be a top level heading [Context: "#bad.md"]
|
||||
[00:00:00] Finished 'markdownlint' after 10 ms
|
||||
```
|
||||
|
||||
|
|
@ -602,9 +608,9 @@ Output:
|
|||
Running "markdownlint:example" (markdownlint) task
|
||||
Warning:
|
||||
bad.md: 3: MD010/no-hard-tabs Hard tabs [Column: 17]
|
||||
bad.md: 1: MD018/no-missing-space-atx No space after hash on atx style header [Context: "#bad.md"]
|
||||
bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style header [Context: "#This file fails some rules."]
|
||||
bad.md: 1: MD041/first-line-h1 First line in file should be a top level header [Context: "#bad.md"]
|
||||
bad.md: 1: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#bad.md"]
|
||||
bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This file fails some rules."]
|
||||
bad.md: 1: MD041/first-line-h1 First line in file should be a top level heading [Context: "#bad.md"]
|
||||
Use --force to continue.
|
||||
```
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue