Skip to content

Commit 8705f23

Browse files
committed
feat: Update docs to reflect changes.
1 parent 33abb31 commit 8705f23

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/usage/configuration/headings.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,13 +469,16 @@ plugins:
469469
[](){#option-show_category_heading}
470470
## `show_category_heading`
471471

472-
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
472+
- **:octicons-package-24: Type [`str|bool`][] :material-equal: `False`{ title="default value" }**
473473
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
474474

475475
When [grouped by categories][group_by_category], show a heading for each category.
476476
These category headings will appear in the table of contents,
477477
allowing you to link to them using their permalinks.
478478

479+
`show_category_heading` can be enabled selectively for individual object types by specifying either `mod` or `class`.
480+
When specified, category headings will only be shown for the chosen type.
481+
479482
WARNING: **Not recommended with deeply nested objects.**
480483
When injecting documentation for deeply nested objects,
481484
you'll quickly run out of heading levels, and the objects

0 commit comments

Comments
 (0)