diff options
author | Jesús Fernández <fernandez.cuesta@gmail.com> | 2015-09-01 17:29:37 +0200 |
---|---|---|
committer | Waylan Limberg <waylan.limberg@icloud.com> | 2018-07-24 15:07:14 -0400 |
commit | a9f1171d3bd7908fbcfd3df0b7b36c9dd7c4607c (patch) | |
tree | b5a43276ec2e4efec137bd56e1800c9de5ab9a93 /docs | |
parent | ae914abeac5d5527e1ada500fe7faf545fbb638c (diff) | |
download | markdown-a9f1171d3bd7908fbcfd3df0b7b36c9dd7c4607c.tar.gz markdown-a9f1171d3bd7908fbcfd3df0b7b36c9dd7c4607c.tar.bz2 markdown-a9f1171d3bd7908fbcfd3df0b7b36c9dd7c4607c.zip |
Add toc_depth parameter to toc extension
Diffstat (limited to 'docs')
-rw-r--r-- | docs/extensions/toc.md | 8 |
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. |