Skip to content
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

Docs: Reference recommended config disabled rules #159

Merged
merged 4 commits into from Aug 15, 2020

Conversation

btmills
Copy link
Member

@btmills btmills commented Aug 13, 2020

#157 took the rules that the documentation already recommended disabling and quite sensibly added them to the plugin:markdown/recommended config, and I've updated the docs accordingly, including a helpful note about plugin rules as suggested by @arvigeus in #157.

You can skip reviewing the first commit, 0b1a905, because it's a cut-and-paste rearrangement to make the diff in the next commit easier to review. The bulk of the change is in d08afa1.

This is a cut-and-paste commit. I'm going to update these to reflect the
recommended config and want to put them under the "Advanced
Configuration" section. I did this in a precursor commit to make
reviewing the actual textual diff easier in the next commit.
These borrow a snippet of text from the corresponding documentation in
the readme.
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Thanks to @ilyavolodin for the suggestions to start this off.
@btmills
Copy link
Member Author

btmills commented Aug 15, 2020

@ilyavolodin thanks for pushing me to simplify. What do you think of 694a073?

Copy link
Member

@ilyavolodin ilyavolodin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks much much better!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants