Docs: README Markdown linting #2283
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
Standardize list item characters to `*` and add newlines between paragraphs. Automatic linting from within VS Code.
jpculp
approved these changes
Jul 19, 2022
stmcginnis
approved these changes
Jul 19, 2022
zmrow
approved these changes
Jul 19, 2022
|
I did some digging and the linter is markdownlint, using Microsoft Docs Authoring Pack rules in VScode. Adding the rules to a pipeline/github action should be possible. |
|
I found what I think are the rules used by the Microsoft Docs Authoring Pack VScode extension (applied via |
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.
Issue number:
#2282
Description of changes:
Standardize list item characters to
*and add newlinesbetween paragraphs. Automatic linting from within VS Code.
Testing done:
eyeballs only 👀
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.