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] config file options #158

Labels

Comments

@naseemkullah
Copy link

@naseemkullah naseemkullah commented Jan 12, 2021

Hello!

Would it be possible for the REAMDE to provide an up to date list of all possible configuration options for the config file?

@DavidAnson
Copy link
Collaborator

@DavidAnson DavidAnson commented Jan 12, 2021

This section of the docs has multiple links: https://github.com/igorshubovych/markdownlint-cli#configuration

Including a list of rules: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

And an explanation of the format: https://github.com/DavidAnson/markdownlint#optionsconfig

What else are you thinking should be included?

@DavidAnson
Copy link
Collaborator

@DavidAnson DavidAnson commented Jan 12, 2021

Are you looking for something like .markdownlint.yaml from your PR? (Except exhaustive.)

@jsumners
Copy link

@jsumners jsumners commented Jan 12, 2021

Are you looking for something like .markdownlint.yaml from your PR? (Except exhaustive.)

Yes. Having to piece together all of the parts is difficult for someone without much time.

@DavidAnson
Copy link
Collaborator

@DavidAnson DavidAnson commented Jan 12, 2021

Okay, I should be able to add something to make this more explicit.

FYI, if you edit the configuration file in VS Code with the markdownlint extension installed, you'll get full intellisense.

Also FYI, if you use CLI2, I already have something like this for its higher-level configuration file:

@DavidAnson
Copy link
Collaborator

@DavidAnson DavidAnson commented Jan 20, 2021

FYI @naseemkullah / @jsumners, this is on the way: DavidAnson/markdownlint@5b7e9b8

@jsumners
Copy link

@jsumners jsumners commented Jan 20, 2021

Looks fantastic. Thank you for accepting the feedback.

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