aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/toc.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/extensions/toc.md')
-rw-r--r--docs/extensions/toc.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/extensions/toc.md b/docs/extensions/toc.md
index e358132..5038428 100644
--- a/docs/extensions/toc.md
+++ b/docs/extensions/toc.md
@@ -134,3 +134,11 @@ The following options are provided to configure the output:
* **`separator`**:
Word separator. Character which replaces white space in id. Defaults to "`-`".
+
+* **`toc_depth`**
+ Define up to which section level "n" (`<h1>` to `<hn>`, where `1 <= n <= 6`)
+ to include in the Table of Contents. Defaults to `6`.
+
+ When used with conjunction with `baselevel` this parameter will limit the
+ resulting (adjusted) heading. That is, if both `toc_depth` and `baselevel`
+ are 3, then only the highest level will be present in the table.