Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 05:50:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update MD043/required-headings to add match_case parameter (fixes #613).

Browse source
This commit is contained in:
Mateus Ferreira 2022-10-22 03:15:50 -04:00 • committed by GitHub
parent 592a42b0cb
commit 37f74ee958
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 125 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/Rules.md
View file

@ -1696,7 +1696,7 @@ Tags: headings, headers
Aliases: required-headings, required-headers
Parameters: headings, headers (array of string; default `null` for disabled)
Parameters: headings, headers, match_case (array of string; default `null` for disabled, boolean; default false)
> If `headings` is not provided, `headers` (deprecated) will be used.
@ -1752,6 +1752,10 @@ problematic heading (otherwise, it outputs the last line number of the file).
Note that while the `headings` parameter uses the "## Text" ATX heading style for
simplicity, a file may use any supported heading style.
By default, the case of headings in the document is not required to match that of
`headings`. To require that case match exactly, set the `match_case` parameter to
`true`.
Rationale: Projects may wish to enforce a consistent document structure across
a set of similar content.