markdownlint icon indicating copy to clipboard operation
markdownlint copied to clipboard

Headings must be title-case

Open alexec opened this issue 2 years ago • 3 comments

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.

alexec avatar May 02 '22 17:05 alexec

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

update: Found this tool and rule

thisislawatts avatar May 08 '22 11:05 thisislawatts

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

alexec avatar May 08 '22 16:05 alexec

I've been working on one that allows configuring both sentence case and title case over here: https://github.com/greyscaled/markdownlint-rule-title-case-style

Still in an early stage, but actively being refined.

greyscaled avatar Oct 28 '23 04:10 greyscaled