Lint documentation with markdownlint #193
Merged
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
- Set line length to 120, the same as our Dart code - In GitHub templates, set top-level heading to h2
- Add the markdownlint extension to recommendations - Set extension to only lint versioned files - Add ruler at column 120 to markdown files - Disable word wrap for markdown files if view is wide enough to enable said ruler
This ensures that future documentation follows linter rules.
- Invoke `markdownlint-cli2-fix` - Manually fix other violations - Identical rendering results
rileychh
added
the
scope: documentation
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.
Description
Add markdownlint to the project, a widely used markdown linter.
Details are in the commit messages.
How to Verify?
Lint all Markdown files in the workspace with markdownlintusing the command palette.npm i -g markdownlint-cli2 && markdownlint-cli2 "**/*.md"pnpm dlx markdownlint-cli2 "**/*.md"yarn dlx markdownlint-cli2 "**/*.md"Screenshots/GIF/Test Results (Optional)
I tested the new
markdownlintworkflow locally using act and it passes.