diff options
| author | Waylan Limberg <waylan.limberg@icloud.com> | 2019-03-25 19:58:02 -0400 |
|---|---|---|
| committer | Waylan Limberg <waylan.limberg@icloud.com> | 2019-03-25 20:16:27 -0400 |
| commit | 39c3c737f2bbf8d38d6233cd95fa21267aaad5ed (patch) | |
| tree | a7be9853bfa3950ec3cf5eb95d49c0fef05cd936 /docs | |
| parent | 0861bb0df43a20737c38029bcf7d09b14d17352f (diff) | |
| download | python-markdown-39c3c737f2bbf8d38d6233cd95fa21267aaad5ed.tar.gz | |
Fix TOC docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/extensions/toc.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/extensions/toc.md b/docs/extensions/toc.md index ae54cba..14169c8 100644 --- a/docs/extensions/toc.md +++ b/docs/extensions/toc.md @@ -198,14 +198,14 @@ The following options are provided to configure the output: * **`toc_depth`** Define the range of section levels to include in the Table of Contents. - A single integer (b) defines the bottom section level (<h1>..<hb>) only. - A string consisting of two digits separated by a hyphen in between ("2-5"), - define the top (t) and the bottom (b) (<ht>..<hb>). Defaults to `6` (bottom). + A single integer (`b`) defines the bottom section level (`<h1>..<hb>`) only. + A string consisting of two digits separated by a hyphen in between (`"2-5"`), + define the top (`t`) and the bottom (`b`) (`<ht>..<hb>`). Defaults to `6` (bottom). When used with conjunction with `baselevel`, this parameter will not take the fitted hierarchy from `baselevel` into account. That is, if - both `toc_depth` and `baselevel` are 3, then only the highest level - will be present in the table. If you set `baselevel` to 3 and - `toc_depth` to '2-6', the *first* headline will be `<h3>` and so still + both `toc_depth` and `baselevel` are `3`, then only the highest level + will be present in the table. If you set `baselevel` to `3` and + `toc_depth` to `"2-6"`, the *first* headline will be `<h3>` and so still included in the Table of Contents. To exclude this first level, you - have to set `toc_depth` to '4-6'.
\ No newline at end of file + have to set `toc_depth` to `"4-6"`.
\ No newline at end of file |