[GH-ISSUE #136] Rule MD024 should be refined [to allow heading duplication for non-siblings] #1963

New issue

Closed

opened 2026-03-07 20:03:11 +03:00 by kerem · 4 comments

kerem commented

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

Owner

Originally created by @bfzhao on GitHub (Jul 17, 2018).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/136

It is reasonable to have rule MD024 to report any title conflict, but it makes sense only when those titles have the same parent title. Below case is very common and should not be reported as an issue:

# cast 1
## RCA
## RCA -----> should report here
## Action List 
# case 2
## RCA -----> should not report here
## Action List

Originally created by @bfzhao on GitHub (Jul 17, 2018). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/136 It is reasonable to have rule MD024 to report any title conflict, but it makes sense only when those titles have the same parent title. Below case is very common and should not be reported as an issue: ``` # cast 1 ## RCA ## RCA -----> should report here ## Action List # case 2 ## RCA -----> should not report here ## Action List ```

kerem

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

closed this issue
added the
enhancement

fixed in next
labels

kerem commented

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

Author

Owner

@DavidAnson commented on GitHub (Jul 17, 2018):

Although this conflicts with the rationale given in the rule description (https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md024---multiple-headings-with-the-same-content), it seems reasonable as an option.

@DavidAnson commented on GitHub (Jul 17, 2018): Although this conflicts with the rationale given in the rule description (https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md024---multiple-headings-with-the-same-content), it seems reasonable as an option.

kerem commented

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

Author

Owner

@DavidAnson commented on GitHub (Jul 17, 2018):

Here’s a corresponding issue/commit from the Ruby implementation:
https://github.com/markdownlint/markdownlint/issues/175

I prefer a parameter name like only_siblings and will probably support both for compatibility.

@DavidAnson commented on GitHub (Jul 17, 2018): Here’s a corresponding issue/commit from the Ruby implementation: https://github.com/markdownlint/markdownlint/issues/175 I prefer a parameter name like `only_siblings` and will probably support both for compatibility.

kerem commented

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

Author

Owner

@Coding-Rod commented on GitHub (Jul 27, 2023):

Add this to your setting.json if using vscode:

"markdownlint.config": {
        "MD024": false
}

@Coding-Rod commented on GitHub (Jul 27, 2023): Add this to your setting.json if using vscode: ```json "markdownlint.config": { "MD024": false } ```

kerem commented

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

Author

Owner

@lveillard commented on GitHub (Nov 13, 2023):

I know it can be ignored, but this rule actually makes sense within the same scope. I think that this rule should be:
a) either enhanced to check only within scope
b) defaulted to false. And a new rule to check same-level conflicts only could be added

@lveillard commented on GitHub (Nov 13, 2023): I know it can be ignored, but this rule actually makes sense within the same scope. I think that this rule should be: a) either enhanced to check only within scope b) defaulted to false. And a new rule to check same-level conflicts only could be added

kerem referenced this issue

2026-03-07 20:14:57 +03:00

[PR #1963] [MERGED] Bump eslint-plugin-jsdoc from 62.5.4 to 62.5.5 #3681