Skip to content

Lint docs #1821

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

Merged
merged 17 commits into from
Mar 19, 2022
Merged

Lint docs #1821

merged 17 commits into from
Mar 19, 2022

Conversation

FloEdelmann
Copy link
Member

@FloEdelmann FloEdelmann commented Mar 18, 2022

With the tools introduced in this PR, inconsistencies in the rule docs will be caught early:

  • heading checker in tools/update-docs.js:
    • reports unknown headings in rules
    • reports inconsistent heading order
  • MarkdownLint (via markdownlint-cli):
    • will run with npm run lint (or in editors with MarkdownLint integration/plugin)
    • reports general inconsistencies

`ul-style` MarkdownLint rule
`ul-indent` MarkdownLint rule
`no-trailing-spaces` MarkdownLint rule
`no-multiple-blanks` MarkdownLint rule
`blanks-around-headings` MarkdownLint rule
`blanks-around-fences` MarkdownLint rule
`blanks-around-lists` MarkdownLint rule
`no-bare-urls` MarkdownLint rule
`no-emphasis-as-heading` MarkdownLint rule
`no-space-in-code` MarkdownLint rule
`fenced-code-language` MarkdownLint rule
@FloEdelmann FloEdelmann requested a review from ota-meshi March 18, 2022 17:22
Copy link
Member

@ota-meshi ota-meshi left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!!

@ota-meshi ota-meshi merged commit 0924d62 into vuejs:master Mar 19, 2022
@FloEdelmann FloEdelmann deleted the docs branch March 19, 2022 06:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants