1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-23 21:04:56 +01:00
mkdocs-material/src/partials/toc.html

49 lines
2.0 KiB
HTML
Raw Normal View History

2016-08-07 18:01:56 +02:00
<!--
2017-01-06 19:11:18 +01:00
Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
2016-08-07 18:01:56 +02:00
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.
-->
2017-01-13 00:31:37 +01:00
{% import "partials/language.html" as lang %}
2017-01-06 18:48:32 +01:00
2016-09-23 11:56:25 +02:00
<!-- Table of contents -->
<nav class="md-nav md-nav--secondary">
2017-01-02 08:57:19 +01:00
{% set toc_ = page.toc %}
2016-08-07 18:01:56 +02:00
2016-09-23 11:56:25 +02:00
<!--
This is a nasty hack that checks 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.
2016-09-23 11:56:25 +02:00
-->
{% if "\x3ch1 id=" in page.content %}
2017-01-02 08:57:19 +01:00
{% set toc_ = (toc_ | first).children %}
2016-09-23 11:56:25 +02:00
{% endif %}
<!-- Render item list -->
2017-01-02 08:57:19 +01:00
{% if toc_ and (toc_ | first) %}
2017-01-13 00:31:37 +01:00
<label class="md-nav__title" for="toc">{{ lang.t('toc.title') }}</label>
2016-12-29 14:19:26 +01:00
<ul class="md-nav__list" data-md-scrollfix>
2017-01-02 08:57:19 +01:00
{% for toc_item in toc_ %}
2016-09-23 11:56:25 +02:00
{% include "partials/toc-item.html" %}
2016-08-07 18:01:56 +02:00
{% endfor %}
</ul>
{% endif %}
</nav>