zola/docs/content/documentation/content/table-of-contents.md at 896c30d89242d60723a1148b1666c85dbc28fd67

photong 51d4b6bd6a Simple clean up of documentation. (#849 )

* Update installation.md

* Update cli-usage.md

* Update installation.md

* Update directory-structure.md

* Update configuration.md

* Update overview.md

* Update section.md

* Update page.md

* Update section.md

* Update configuration.md

* Update page.md

* Update section.md

* Update page.md

* Update shortcodes.md

* Update linking.md

* Update table-of-contents.md

* Update syntax-highlighting.md

* Update taxonomies.md

* Update search.md

* Update sass.md

* Update index.md

* Update multilingual.md

* Update overview.md

* Update pages-sections.md

* Update pagination.md

* Update taxonomies.md

* Update rss.md

* Update sitemap.md

* Update robots.md

* Update 404.md

* Update archive.md

* Update overview.md

* Update installing-and-using-themes.md

* Update creating-a-theme.md

* Update netlify.md

* Update github-pages.md

* Update gitlab-pages.md

* Update index.md

* Update page.md

* Update section.md

* Updates.

2020-02-02 17:48:42 -08:00

1.1 KiB

Raw Blame History

+++ title = "Table of Contents" weight = 60 +++

Each page/section will automatically generate a table of contents for itself based on the headers present.

It is available in the template through the page.toc or section.toc variable. You can view the template variables documentation for information on its structure.

Here is an example of using that field to render a two-level table of contents:

<ul>
{% for h1 in page.toc %}
    <li>
        <a href="{{h1.permalink | safe}}">{{ h1.title }}</a>
        {% if h1.children %}
            <ul>
                {% for h2 in h1.children %}
                    <li>
                        <a href="{{h2.permalink | safe}}">{{ h2.title }}</a>
                    </li>
                {% endfor %}
            </ul>
        {% endif %}
    </li>
{% endfor %}
</ul>

While headers are neatly ordered in this example, it will work just as well with disjoint headers.

Note that all existing HTML tags from the title will NOT be present in the table of contents to avoid various issues.

1.1 KiB Raw Blame History

1.1 KiB

Raw Blame History