[GH-ISSUE #162] default config for a repo #140

Closed
opened 2026-03-03 01:24:04 +03:00 by kerem · 1 comment
Owner

Originally created by @yankeeinlondon on GitHub (Jan 11, 2019).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/162

Possibly this is a documentation issue but I want a way to add a config file to the root of one of my repo to ignore certain rules and add others. In the docs I see a way to change rules with frontmatter and HTML comments but not as a default config file.

Note: there is some reference to an "options" object but I have on idea what file naming convention to use to have this get picked up.

Originally created by @yankeeinlondon on GitHub (Jan 11, 2019). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/162 Possibly this is a documentation issue but I want a way to add a config file to the root of one of my repo to ignore certain rules and add others. In the docs I see a way to change rules with **frontmatter** and **HTML comments** but not as a default config file. > Note: there is some reference to an "options" object but I have on idea what file naming convention to use to have this get picked up.
kerem 2026-03-03 01:24:04 +03:00
  • closed this issue
  • added the
    question
    label
Author
Owner

@DavidAnson commented on GitHub (Jan 11, 2019):

This package provides a function that you call with whatever input you choose. If you want to standardize on a configuration file of a particular name in a particular place when calling it, that is under your control.

That said, if you are (also) using markdownlint-cli or vscode-markdownlint, both automatically apply any rule configuration you have in a file named .markdownlint.json.

Here’s some documentation about that: https://github.com/DavidAnson/vscode-markdownlint/blob/master/README.md#markdownlintconfig

And an example: https://github.com/DavidAnson/vscode-markdownlint/blob/master/.markdownlint.json

<!-- gh-comment-id:453678197 --> @DavidAnson commented on GitHub (Jan 11, 2019): This package provides a function that you call with whatever input you choose. If you want to standardize on a configuration file of a particular name in a particular place when calling it, that is under your control. That said, if you are (also) using `markdownlint-cli` or `vscode-markdownlint`, both automatically apply any rule configuration you have in a file named `.markdownlint.json`. Here’s some documentation about that: https://github.com/DavidAnson/vscode-markdownlint/blob/master/README.md#markdownlintconfig And an example: https://github.com/DavidAnson/vscode-markdownlint/blob/master/.markdownlint.json
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/markdownlint#140
No description provided.