summaryrefslogtreecommitdiff
path: root/templates/macros/table_of_contents.html
blob: 18a3ab6d92618d063e49b649f5d28d3ce958a6d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{% macro toc(page, header, language_strings="") %}

{%- set toc_levels = page.extra.toc_levels | default(value=3) -%}

{% if page.extra.toc_ignore_pattern %}
    {%- set toc_ignore_pattern = page.extra.toc_ignore_pattern -%}
{% endif %}

<div class="toc-container">
    {% if header %}
        <h3>{{ macros_translate::translate(key="table_of_contents", default="Table of Contents", language_strings=language_strings) }}</h3>
    {% endif %}

    <ul>
        {% for h1 in page.toc %}
            {# Only render headers if there's no ignore pattern, or if the header text doesn't match the pattern. #}
            {% if not toc_ignore_pattern or not (h1.title is matching(toc_ignore_pattern)) %}
                <li><a href="{{ h1.permalink | safe }}">{{ h1.title }}</a>
                    {% if h1.children and toc_levels > 1 %}
                        <ul>
                            {% for h2 in h1.children %}
                                {% if not toc_ignore_pattern or not (h2.title is matching(toc_ignore_pattern)) %}
                                    <li><a href="{{ h2.permalink | safe }}">{{ h2.title }}</a>
                                        {% if h2.children and toc_levels > 2 %}
                                            <ul>
                                                {% for h3 in h2.children %}
                                                    {% if not toc_ignore_pattern or not (h3.title is matching(toc_ignore_pattern)) %}
                                                        <li><a href="{{ h3.permalink | safe }}">{{ h3.title }}</a>
                                                            {% if h3.children and toc_levels > 3 %}
                                                                <ul>
                                                                    {% for h4 in h3.children %}
                                                                        {% if not toc_ignore_pattern or not (h4.title is matching(toc_ignore_pattern)) %}
                                                                            <li><a href="{{ h4.permalink | safe }}">{{ h4.title }}</a></li>
                                                                        {% endif %}
                                                                    {% endfor %}
                                                                </ul>
                                                            {% endif %}
                                                        </li>
                                                    {% endif %}
                                                {% endfor %}
                                            </ul>
                                        {% endif %}
                                    </li>
                                {% endif %}
                            {% endfor %}
                        </ul>
                    {% endif %}
                </li>
            {% endif %}
        {% endfor %}
    </ul>
</div>

{% endmacro toc %}