Skip to content

chore: Add Markdownlint#2354

Merged
1 commit merged intonodejs:masterfrom
nschonni:chore--Add-Markdownlint
Aug 5, 2019
Merged

chore: Add Markdownlint#2354
1 commit merged intonodejs:masterfrom
nschonni:chore--Add-Markdownlint

Conversation

@nschonni
Copy link
Copy Markdown
Member

  • Add Markdownlint checking for Markdown files
  • Add .markdownlint.json to disable all non-passing rules to start
  • Add markdownlint run to the test:lint target

- Add Markdownlint checking for Markdown files
- Add .markdownlint.json to disable all non-passing rules to start
- Add markdownlint run to the test:lint target
@ghost ghost requested review from a user and lpinca July 26, 2019 03:20
Comment thread .markdownlint.json
@@ -0,0 +1,36 @@
{
"default": true,
"MD001": false,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it makes sense to use yaml and add comments to explain what the rules do.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think YAML is supported in the Node version, but they do have "aliases" for the rules that are more readable. I just stuck with the rule names for the initial pass to disable the failing ones, but if you want to do a styleguide, the aliases are better

@ghost ghost merged commit 332f84d into nodejs:master Aug 5, 2019
@nschonni nschonni deleted the chore--Add-Markdownlint branch August 5, 2019 16:17
This was referenced Jan 16, 2022
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants