Remove rule aliases for "header" (deprecated in v0.9.0).

This commit is contained in:
David Anson 2023-11-09 20:05:30 -08:00
parent 20a552b4b7
commit a9a77940c5
45 changed files with 138 additions and 600 deletions

View file

@ -1,17 +1,14 @@
# `MD043` - Required heading structure
Tags: `headers`, `headings`
Tags: `headings`
Aliases: `required-headers`, `required-headings`
Aliases: `required-headings`
Parameters:
- `headers`: List of headings (`string[]`, default `[]`)
- `headings`: List of headings (`string[]`, default `[]`)
- `match_case`: Match case of headings (`boolean`, default `false`)
> If `headings` is not provided, `headers` (deprecated) will be used.
This rule is triggered when the headings in a file do not match the array of
headings passed to the rule. It can be used to enforce a standard heading
structure for a set of files.