[GH-ISSUE #521] Headings must be title-case #2272

Open
opened 2026-03-07 20:06:12 +03:00 by kerem · 3 comments
Owner

Originally created by @alexec on GitHub (May 2, 2022).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/521

I've a lot of documentation where the heading are a mixture of the following:

  • Sentance-case
  • Title-case
  • Mixture (e.g. "About Settings and Config")

Like genders in German, it is impossible to codify simple rules for "mixture".

Instead, I want all heading to be title-case. Problem solved.

Originally created by @alexec on GitHub (May 2, 2022). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/521 I've a lot of documentation where the heading are a mixture of the following: * Sentance-case * Title-case * Mixture (e.g. "About Settings and Config") Like genders in German, it is impossible to codify simple rules for "mixture". Instead, I want all heading to be title-case. Problem solved.
Author
Owner

@thisislawatts commented on GitHub (May 8, 2022):

This sounds great @alexec, exactly what I was looking for in a tool to lint Markdown.

update: Found this tool and rule

<!-- gh-comment-id:1120401012 --> @thisislawatts commented on GitHub (May 8, 2022): This sounds great @alexec, exactly what I was looking for in a tool to lint Markdown. _update:_ Found [this tool and rule](https://www.npmjs.com/package/markdownlint-rule-titlecase)
Author
Owner

@alexec commented on GitHub (May 8, 2022):

Awesome. I’ll leave this issue open as I think it should be a core rule.

<!-- gh-comment-id:1120447493 --> @alexec commented on GitHub (May 8, 2022): Awesome. I’ll leave this issue open as I think it should be a core rule.
Author
Owner

@wences-dc-uba-ar commented on GitHub (Oct 5, 2024):

In case this is ever implemented, please don't make it enabled by default.
Thanks.

<!-- gh-comment-id:2395000512 --> @wences-dc-uba-ar commented on GitHub (Oct 5, 2024): In case this is ever implemented, please don't make it enabled by default. Thanks.
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#2272
No description provided.