Skip to content

Commit abfa627

Browse files
committed
clarify frontmatter title as level 1 heading
1 parent ce747ac commit abfa627

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/rules/heading-increment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Goodbye World!
2929

3030
The following options are available on this rule:
3131

32-
* `frontmatterTitle: string` - A regex pattern to match title fields in front matter. The default pattern matches YAML (`title:`), TOML (`title =`), and JSON (`"title":`) formats. Set to an empty string to disable front matter title checking.
32+
* `frontmatterTitle: string` - A regex pattern to match title fields in front matter. Front matter titles matching this pattern are treated as level 1 headings. The default pattern matches YAML (`title:`), TOML (`title =`), and JSON (`"title":`) formats. Set to an empty string to disable front matter title checking.
3333

3434
Examples of **incorrect** code for this rule:
3535

0 commit comments

Comments
 (0)