[GH-ISSUE #287] Document the .markdownlintignore feature in the README #2097

New issue

Closed

opened 2026-03-07 20:04:31 +03:00 by kerem · 2 comments

kerem commented

2026-03-07 20:04:31 +03:00

Owner

Originally created by @KasparEtter on GitHub (May 15, 2020).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/287

When looking into how to ignore files, I stumbled upon https://github.com/DavidAnson/vscode-markdownlint#markdownlintignore and I think the .markdownlintignore file should also be documented in the README of this project (because this is where people look first).

(Now that I know what to search for, I also saw the issue #245. Is it such a new feature then?)

Let me know if you want me to make a pull request. I think the content could just be copy-pasted from the link above.

Originally created by @KasparEtter on GitHub (May 15, 2020). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/287 When looking into how to ignore files, I stumbled upon https://github.com/DavidAnson/vscode-markdownlint#markdownlintignore and I think the `.markdownlintignore` file should also be documented in the README of this project (because this is where people look first). (Now that I know what to search for, I also saw the issue #245. Is it such a new feature then?) Let me know if you want me to make a pull request. I think the content could just be copy-pasted from the link above.

kerem

2026-03-07 20:04:31 +03:00

closed this issue
added the
question
label

kerem commented

2026-03-07 20:04:32 +03:00

Author

Owner

@DavidAnson commented on GitHub (May 15, 2020):

Only the VS Code extension and the CLI will automatically look for and use a .markdownlint.json file. Both already document that. Providing custom config to this library is documented in the following places:

@DavidAnson commented on GitHub (May 15, 2020): Only the VS Code extension and the CLI will automatically look for and use a `.markdownlint.json` file. Both already document that. Providing custom config to this library is documented in the following places: - https://github.com/DavidAnson/markdownlint/blob/master/README.md#optionsconfig - https://github.com/DavidAnson/markdownlint/blob/master/README.md#config

kerem commented

2026-03-07 20:04:32 +03:00

Author

Owner

@KasparEtter commented on GitHub (May 17, 2020):

I see. I probably got confused by the different projects. Here is the documentation for the CLI: https://github.com/igorshubovych/markdownlint-cli#ignoring-files. Let's close this issue again then.

@KasparEtter commented on GitHub (May 17, 2020): I see. I probably got confused by the different projects. Here is the documentation for the CLI: https://github.com/igorshubovych/markdownlint-cli#ignoring-files. Let's close this issue again then.