zola/docs/content/documentation/content/table-of-contents.md
Vincent Prouillet dee1dbe667 Working on site
And some tweaks as I write the docs
2017-09-29 15:37:58 +09:00

961 B

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

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

TODO: add link for template variables It is available in the template through section.toc and page.toc. You can view the template variables documentation for information on its structure.

Here is an example of using that field to render a 2-level table of content:

<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 that example, it will work just as well with disjoint headers.