starred/markdownlint

Fork 0

mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-04-25 09:16:02 +03:00

[GH-ISSUE #159] Add option to ignore files #138

New issue

Closed

opened 2026-03-03 01:24:03 +03:00 by kerem · 5 comments

kerem commented

2026-03-03 01:24:03 +03:00

Owner

Originally created by @SetTrend on GitHub (Dec 13, 2018).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/159

Please add a configuration opportunity to exclude particular files from the linter.

Either allow globbing for the config.files option:

files: ["**/[a-cA-C]*.md"]

Or add a new configuration option, explicitly excluding files (again, with globbin):

exclude: ["**/__*.md"]

Originally created by @SetTrend on GitHub (Dec 13, 2018). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/159 Please add a configuration opportunity to exclude particular files from the linter. Either allow globbing for the `config.files` option: ``` files: ["**/[a-cA-C]*.md"] ``` Or add a new configuration option, explicitly excluding files (again, with globbin): ``` exclude: ["**/__*.md"] ```

kerem

2026-03-03 01:24:03 +03:00

closed this issue
added the
question
label

kerem commented

2026-03-03 01:24:04 +03:00

Author

Owner

@DavidAnson commented on GitHub (Dec 13, 2018):

Can you explain this request a bit more, please? As the caller, you control the contents of the files array - why not filter out the files you want before passing in the files array? You could use glob, or you could use any other technique. The current implementation allows complete flexibility to the caller.

(Aside: markdownlint-cli supports glob and the ability to exclude by glob - perhaps it is a good reference example?)

@DavidAnson commented on GitHub (Dec 13, 2018): Can you explain this request a bit more, please? As the caller, you control the contents of the files array - why not filter out the files you want before passing in the files array? You could use glob, or you could use any other technique. The current implementation allows complete flexibility to the caller. (Aside: markdownlint-cli supports glob and the ability to exclude by glob - perhaps it is a good reference example?)

kerem commented

2026-03-03 01:24:04 +03:00

Author

Owner

@SetTrend commented on GitHub (Dec 13, 2018):

Thanks, David,

I'm participating in the documentation repository of WebPack. Doing so, I wrote a script that concatenates their single MD pages into comprehensive chapter MD pages, so their information can be viewd/printed in one single document.

That's all highly dynamic. No static maintenance should be required to utilize this feature. This is particularly true due to the high amount of MD pages already present.

So I need wildcards to be able to exclude the generated files (in this particular project their filenames all start with an underscore) from the linter, since, of cource, chances are that headings are being duplicated in the compound files, which should not occur in the original files.

@SetTrend commented on GitHub (Dec 13, 2018): Thanks, David, I'm participating in the [documentation repository of WebPack](https://github.com/webpack/webpack.js.org/issues/2632#issuecomment-446844383). Doing so, I wrote a script that concatenates their single MD pages into comprehensive chapter MD pages, so their information can be viewd/printed in one single document. That's all highly dynamic. No static maintenance should be required to utilize this feature. This is particularly true due to the high amount of MD pages already present. So I need wildcards to be able to exclude the generated files (in this particular project their filenames all start with an underscore) from the linter, since, of cource, chances are that headings are being duplicated in the compound files, which should not occur in the original files.

kerem commented

2026-03-03 01:24:04 +03:00

Author

Owner

@SetTrend commented on GitHub (Dec 13, 2018):

I just went through the scripts in the package.json file of the project and noticed they are using markdown-cli. I will see if I can use globbing there, as you suggested. Thanks for the hint! As soon as I success I will close this issue then.

@SetTrend commented on GitHub (Dec 13, 2018): I just went through the scripts in the `package.json` file of the project and noticed they are using `markdown-cli`. I will see if I can use globbing there, as you suggested. Thanks for the hint! As soon as I success I will close this issue then.

kerem commented

2026-03-03 01:24:04 +03:00

Author

Owner

@SetTrend commented on GitHub (Dec 14, 2018):

Works like a charm. Thanks!

@SetTrend commented on GitHub (Dec 14, 2018): Works like a charm. Thanks!

kerem commented

2026-03-03 01:24:04 +03:00

Author

Owner

@elgalu commented on GitHub (Jun 29, 2021):

Also setting --ignore in a pre-commit works like a charm, e.g.

  - repo: https://github.com/igorshubovych/markdownlint-cli
    rev: "596386e6a7da92547c4fc6b94fce59bcbc8290ee" # frozen: v0.27.1
    hooks:
      - id: markdownlint
        args: ["--ignore", "towncrier-template.md"]

@elgalu commented on GitHub (Jun 29, 2021): Also setting `--ignore` in a pre-commit works like a charm, e.g. ```yaml - repo: https://github.com/igorshubovych/markdownlint-cli rev: "596386e6a7da92547c4fc6b94fce59bcbc8290ee" # frozen: v0.27.1 hooks: - id: markdownlint args: ["--ignore", "towncrier-template.md"] ```

kerem referenced this issue

2026-03-07 20:03:11 +03:00

[GH-ISSUE #138] Add rule for ordered list indentation (ol-indent) #1964