Add .markdownlintrc config file for markdownlint #942
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
This adds a config file `.markdownlintrc` for use with `markdownlint`. After discovering the Google Markdown style guide at https://google.github.io/styleguide/docguide/style.html, it seemed sensible to make our Markdown files be as close to the Google style as possible while still being compatible with GitHub-flavored Markdown. This new config file tries to achieve that.
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.
This adds a config file
.markdownlintrcfor use withmarkdownlint. After discovering the Google Markdown style guide at https://google.github.io/styleguide/docguide/style.html, it seemed sensible to make our Markdown files be as close to the Google style as possible while still being compatible with GitHub-flavored Markdown. This new config file tries to achieve that.