Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add Markdownlint #2354

Merged
merged 1 commit into from
Aug 5, 2019
Merged

Conversation

nschonni
Copy link
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
@@ -0,0 +1,36 @@
{
"default": true,
"MD001": false,
Copy link
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
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

@SEWeiTung SEWeiTung 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
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.

3 participants