-
Notifications
You must be signed in to change notification settings - Fork 86
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
configure markdown lint #522
Conversation
First configuration of markdown lint. We can determine which warnings we want to enable or disable from a first test run.
- Disable long line lengths. (We use hard breaks for paragraphs) - Disable inline HTML.
@jskeet Here's a PR that turns on markdown lint in our repo. Over time, it's probably a good idea to have it on with most warnings enable. I already turned off 2 by design:
We use both of those intentionally. Take a look at the warnings. See which ones are most helpful to get our markdown source to work well with the word converter. Then, we can figure out a plan. |
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.
All the current warnings look good to me - thanks!
I'm think of this as a plan:
|
Works for me :) |
A couple note on this commit: MD034 is for "raw URL link". The standard contains the link to the ECMA site, which is intentional. If it helps the word converter, that can be formatted using markdown's `[]()` syntax. MD30 and MD31 will be the two biggest jobs. Also, some of the warnings are generated from the markdown source in the test project. I think the right move will be to update those test sources once the associated rules are enabled.
I want to verify a couple assumptions.
@jskeet This is ready for final review. I want you to take a look because of some of rules changes:
|
I'll look at this on Monday if that's okay - my weekend is pretty busy. |
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.
Yup, this feels like a good approach to me.
First configuration of markdown lint. We can determine which warnings we want to enable or disable from a first test run.
We can adjust what's reported by adding items from the markdown lint rules.