thang/notes
1
0
Fork 0
mirror of https://github.com/thangisme/notes.git synced 2024-12-22 03:16:32 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'collapsible-toc' of git://github.com/pdmosses/just-the-docs into pdmosses-collapsible-toc

Browse Source
This commit is contained in:
Patrick Marsceill 2020-06-30 12:54:51 -04:00
commit c8bbcc2d9b
No known key found for this signature in database
GPG Key ID: 286B93882D828F40
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/navigation-structure.md
View File

@ -7,11 +7,14 @@ nav_order: 5
# Navigation Structure
{: .no_toc }
## Table of contents
{: .no_toc .text-delta }
<details open markdown="block">
<summary>
Table of contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
---
@ -231,4 +234,19 @@ To generate a Table of Contents on your docs pages, you can use the `{:toc}` met
{:toc}
```
This example skips the page name heading (`#`) from the TOC, as well as the heading for the Table of Contents itself (`##`) because it is redundant, followed by the table of contents itself.
This example skips the page name heading (`#`) from the TOC, as well as the heading for the Table of Contents itself (`##`) because it is redundant, followed by the table of contents itself. To get an unordered list, replace `1. TOC` above by `- TOC`.
The table of contents can be made collapsible by adding HTML markup, as in the following example. The attribute `open` and the styling with `{: .text-delta }` are optional.
```markdown
<details open markdown="block">
<summary>
Table of contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
```
The result is shown at [the top of this page](#navigation-structure) (`{:toc}` can be used only once on each page).