Update .markdownlint.json to ignore first line as heading #537
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ignoring first line as heading allows a template to begin with the description contents for each submission type.
vortexau
requested changes
Sep 16, 2024
There was a problem hiding this comment.
Given recent changes to templates now removes the header, I am of the opinion that it would be better for the linter to fail for any template that still contains the header.
This change would then probably be "first-line-heading": true, and the linter should then fail if a heading exists on the first line. I think. Test that before committing 😅
`"MD041": false,` tells the linting tool to ignore the rule that says that the first line must start with a heading. e.g. # Title of File. This will allow the template.md files to start with the description of the vulnerability. A feature which will decrease the time it takes for penetration testing report creation.
|
While the latest change has not solved for flagging files that do start with a heading, e.g. |
vortexau
approved these changes
Sep 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ignoring first line as heading allows a template to begin with the description contents for each submission type.