Update docs to recommend markdownlint-cli2
#20
Merged
Conversation
This file contains hidden or 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
khiga8
commented
Dec 22, 2022
|
|
||
| ### Should I disable rules enabled by this plugin? | ||
|
|
||
| This plugin will enable the defaults defined by `markdownlint`. Several of these pertain to stylistic practices. You may choose to disable these rules if you determine it doesn't provide value for your project. |
There was a problem hiding this comment.
This is a new section.
I think this guidance aligns with the intent mentioned https://github.com/github/accessibility/pull/1614#discussion_r942717616.
enable all defaults and show explicitly which rules we're not adhering to.
khiga8
commented
Dec 22, 2022
|
|
||
| However, others of these rules should **NOT** be disabled because they encourage best accessibility practices. Disabling these rules will negatively impact accessibility. These rules are specified in [accessibility.json](./accessibility.json). | ||
|
|
||
| ## Rules |
There was a problem hiding this comment.
This is a new section. More comprehensive docs can be added in #12.
khiga8
commented
Dec 22, 2022
readme.md
Outdated
| ``` | ||
|
|
||
| Notice that disabling some rules will have a negative impact on accessibility. | ||
| 5. Install the [`vscode-markdownlint`](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) plugin to ensure `markdownlint` violations are surfaced in the file. This plugin should flag rules based off your `.markdownlint-cli2.cjs` configuration. |
|
👋 Hello and thanks for pinging us! An accessibility first responder will review this soon.
|
khiga8
commented
Dec 22, 2022
| @@ -0,0 +1,12 @@ | |||
| const options = require('./index.js').init({ | |||
There was a problem hiding this comment.
Converting to use markdownlint-cli2 in this project to align with our recs.
andrialexandrou
approved these changes
Dec 22, 2022
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.
Fixes: #19
This PR updates the docs to recommend using
markdownlint-cli2because it is compatible with the VSCode plugin, whilemarkdownlint-cliis not. This updates the configuration setup accordingly. I've replaced the configuration setup for the markdownlinting of this repo as well.Additionally, this PR introduces a list of the rules defined by this library. We can introduce more comprehensive docs for these rules as part of #12.