Add name first-line-heading to MD041 for clarity (refs #169).

This commit is contained in:
David Anson 2019-03-13 21:39:15 -07:00
parent 0184f9d618
commit 050cbbba82
5 changed files with 5 additions and 5 deletions

View file

@ -82,7 +82,7 @@ playground for learning and exploring.
* **[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 heading
* **[MD041](doc/Rules.md#md041)** *first-line-heading/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-headings/required-headers* - Required heading structure
* **[MD044](doc/Rules.md#md044)** *proper-names* - Proper names should have the correct capitalization

View file

@ -1348,7 +1348,7 @@ echo Hello world
Tags: headings, headers
Aliases: first-line-h1
Aliases: first-line-heading, first-line-h1
Parameters: level, front_matter_title (number; default 1, string; default "^\s*title:")

View file

@ -5,7 +5,7 @@
const shared = require("./shared");
module.exports = {
"names": [ "MD041", "first-line-h1" ],
"names": [ "MD041", "first-line-heading", "first-line-h1" ],
"description": "First line in file should be a top level heading",
"tags": [ "headings", "headers" ],
"function": function MD041(params, onError) {

View file

@ -1,7 +1,7 @@
[
{
"lineNumber": 1,
"ruleNames": [ "MD041", "first-line-h1" ],
"ruleNames": [ "MD041", "first-line-heading", "first-line-h1" ],
"ruleDescription": "First line in file should be a top level heading",
"ruleInformation": "https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/Rules.md#md041",
"errorDetail": null,

View file

@ -10,7 +10,7 @@
},
{
"lineNumber": 4,
"ruleNames": [ "MD041", "first-line-h1" ],
"ruleNames": [ "MD041", "first-line-heading", "first-line-h1" ],
"ruleDescription": "First line in file should be a top level heading",
"ruleInformation": "https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/Rules.md#md041",
"errorDetail": null,