mkdocs-material/src/partials/toc.html

<!--
  Copyright (c) 2016-2018 Martin Donath <martin.donath@squidfunk.com>

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to
  deal in the Software without restriction, including without limitation the
  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  sell copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  IN THE SOFTWARE.
-->

{% import "partials/language.html" as lang with context %}

<!-- Table of contents -->
<nav class="md-nav md-nav--secondary">
  {% set toc_ = page.toc %}

  <!--
    Hack: check whether the content contains a h1 headline. If it does, the
    top-level anchor must be skipped, since it would be redundant to the link
    to the current page that is located just above the anchor. Therefore we
    directly continue with the children of the anchor.
  -->
  {% if toc_ | first is defined and "\x3ch1 id=" in page.content %}
    {% set toc_ = (toc_ | first).children %}
  {% endif %}

  <!-- Render item list -->
  {% if toc_ | first is defined %}
    <label class="md-nav__title" for="toc">{{ lang.t("toc.title") }}</label>
    <ul class="md-nav__list" data-md-scrollfix>
      {% for toc_item in toc_ %}
        {% include "partials/toc-item.html" %}
      {% endfor %}

      <!-- Source files -->
      {% if page.meta.source and page.meta.source | length > 0 %}
        <li class="md-nav__item">
          <a href="#__source" title="{{ lang.t('meta.source') }}"
              class="md-nav__link md-nav__link--active">
            {{ lang.t("meta.source") }}
          </a>
        </li>
      {% endif %}

      <!-- Disqus integration -->
      {% set disqus = config.extra.disqus %}
      {% if page and page.meta and page.meta.disqus is string %}
        {% set disqus = page.meta.disqus %}
      {% endif %}
      {% if disqus %}
        <li class="md-nav__item">
          <a href="#__comments" title="{{ lang.t('meta.comments') }}"
              class="md-nav__link md-nav__link--active">
            {{ lang.t("meta.comments") }}
          </a>
        </li>
      {% endif %}
    </ul>
  {% endif %}
</nav>