Skip to content

Commit ac2e38d

Browse files
Allow a body heading alongside the front matter title in the markdown linter config
Set MD025 front_matter_title to an empty pattern so a front matter title: is no longer counted as the document's top-level heading. Pages can now carry both the front matter title MkDocs uses for navigation and the body heading that renders on github.com. An empty pattern is used rather than disabling MD025, so the rule still reports a genuinely duplicated top-level heading. Converges with the same setting in MSXOrg/docs. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent aa0d124 commit ac2e38d

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

.github/linters/.markdown-lint.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ MD007:
1414
MD013:
1515
line_length: 808 # Line length
1616
MD024: false # no-duplicate-heading, INPUTS and OUTPUTS _can_ be the same item
17+
MD025:
18+
front_matter_title: '' # Allow a body H1 alongside the front matter title
1719
MD026:
1820
punctuation: '.,;:!。,;:' # List of not allowed
1921
MD029: false # Ordered list item prefix

0 commit comments

Comments
 (0)