- Notifications
You must be signed in to change notification settings - Fork5
Update README.md#31
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
👋 Hello and thanks for pinging us! An accessibility first responder will review this soon.
|
| In addition to defaults defined by `markdownlint`, we use this repository to enforce rules not defined by default, including our own custom rules. | ||
| See our opinions codified in [index.js](./index.js). | ||
| ### Should I disable rules enabled by this plugin? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Moving this down after the setup where it makes more sense.
| ## Opinions | ||
| At GitHub, we have opinions about how our markdown should be written. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This seemed redundant so removing.
| We are using the [`markdownlint`](https://github.com/DavidAnson/markdownlint) library (via [`markdownlint-cli2`](https://github.com/DavidAnson/markdownlint-cli2) and adding our opinions and custom rules to it. | ||
| To review behaviors supported by `markdownlint`, particularly how to enable or disable rules, see [`markdownlint-cli2` configuration](https://github.com/DavidAnson/markdownlint-cli2#configuration). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I moved portions of this down into the setup section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
🎉
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: Lindsey Wild <35239154+lindseywild@users.noreply.github.com>
Fixes:#29
Adds instructions for configuring formatter which will ensure error messages include link to rule documentation (which doesn't happen by default).
Also does minor clean-up.