docs-toc.html.twig

{% capture tocWorkspace %}
    {% comment %}
        Version 1.0.4
          https://github.com/allejo/jekyll-toc

        "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe

        Usage:
            {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %}

        Parameters:
            * html       (string) - the HTML of compiled markdown generated by kramdown in Jekyll

        Optional Parameters:
            * sanitize   (bool)   : false  - when set to true, the headers will be stripped of any HTML in the TOC
            * class      (string) :   ''   - a CSS class assigned to the TOC
            * id         (string) :   ''   - an ID to assigned to the TOC
            * h_min      (int)    :   1    - the minimum TOC header level to use; any header lower than this value will be ignored
            * h_max      (int)    :   6    - the maximum TOC header level to use; any header greater than this value will be ignored
            * ordered    (bool)   : false  - when set to true, an ordered list will be outputted instead of an unordered list
            * item_class (string) :   ''   - add custom class for each list item; has support for '%level%' placeholder, which is the current heading level
            * item_link_class (string) :   ''   - add custom class for each link in list item;

        Output:
            An ordered or unordered list representing the table of contents of a markdown block. This snippet will only generate the table of contents and will NOT output the markdown given to it
    {% endcomment %}

    {% capture my_toc %}{% endcapture %}
    {% assign orderedList = include.ordered | default: false %}
    {% assign minHeader = include.h_min | default: 1 %}
    {% assign maxHeader = include.h_max | default: 6 %}
    {% assign nodes = include.html | split: '<h' %}
    {% assign firstHeader = true %}

    {% capture listModifier %}{% if orderedList %}1.{% else %}-{% endif %}{% endcapture %}

    {% for node in nodes %}
        {% if node == "" %}
            {% continue %}
        {% endif %}

        {% assign headerLevel = node | replace: '"', '' | slice: 0, 1 | times: 1 %}

        {% if headerLevel < minHeader or headerLevel > maxHeader %}
            {% continue %}
        {% endif %}

        {% if firstHeader %}
            {% assign firstHeader = false %}
            {% assign minHeader = headerLevel %}
        {% endif %}

        {% assign indentAmount = headerLevel | minus: minHeader | add: 1 %}
        {% assign _workspace = node | split: '</h' %}

        {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
        {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
        {% assign html_id = _idWorkspace[0] %}

        {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
        {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}

        {% assign space = '' %}
        {% for i in (1..indentAmount) %}
            {% assign space = space | prepend: '    ' %}
        {% endfor %}

        {% unless include.item_class == blank %}
            {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}
        {% endunless %}

        {% unless include.item_link_class == blank %}
            {% capture listItemLinkClass %}{:.{{ include.item_link_class }}}{% endcapture %}
        {% endunless %}

        {% capture subListClass %}{:.vgm}{% endcapture %}

        {% capture my_toc %}{{ my_toc }}
{{ space }}{{ listModifier }} {{ listItemClass }} [{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}](#{{ html_id }}){{ listItemLinkClass }}{% endcapture %}

    {% endfor %}

    {% if include.class %}
        {% capture my_toc %}{:.{{ include.class }}}
{{ my_toc | lstrip }}{% endcapture %}
    {% endif %}

    {% if include.id %}
        {% capture my_toc %}{: #{{ include.id }}}
{{ my_toc | lstrip }}{% endcapture %}
    {% endif %}
{% endcapture %}
{% assign tocWorkspace = '' %}

{% assign newSubUlClass = 'nav' %}
{% capture subUlTpl %}ul class="{{ newSubUlClass }}"{% endcapture %}
{% assign subUl = subUlTpl | append: ">" | prepend: "<" %}
{% assign result = my_toc | markdownify | replace: '<ul>', subUl | strip  %}
{% if result contains 'ul' %}
  <div class="toc-title h6 mb-2 text-uppercase font-weight-bold">{{ site.data.translations[site.locale].toc_label }}</div>
{% endif %}
{{ result }}