diff --git a/configuration/project.md b/configuration/project.md index 2841cc8c1..62772331e 100644 --- a/configuration/project.md +++ b/configuration/project.md @@ -1680,12 +1680,31 @@ The `toc` config contains project options that apply to the right sidebar Table ### depth === [!badge PRO] depth : `string`, `number` +The heading depth to include in the right Table of Contents. + The default is `2-3`. ```yml toc: depth: 2-3 ``` + +The `toc` can be configured at the Project or Page levels. + +Configuring the `toc` at the Page level overrides the Project level settings. + +Acceptable values for `depth` include: + +Value | Description +--- | --- +2 | Include `H2` headings only +2-3 | `default` Include `H2` to `H3` headings +1-4 | Include `H1` to `H3` headings +2,3 | Include `H2` and `H3` headings +2,4 | Include `H2` and `H4` headings +1,3-4 | Include `H1` and `H3` to `H4` headings, skip `H2` +1,2,3,4 | Include `H1`, `H2`, `H3`, and `H4` headings + === ### label