Adapt to latest mkdocs-material version

oprypin · Dec 21, 2020 · e04d0c4 · e04d0c4
1 parent d6cb9b8
commit e04d0c4
Show file tree

Hide file tree

Showing 3 changed files with 215 additions and 0 deletions.
diff --git a/mkdocs_section_index/rewrites.py b/mkdocs_section_index/rewrites.py
@@ -60,6 +60,10 @@ def _transform_material_nav_item_template(src: str) -> str:
 
 
 def _transform_material_tabs_item_template(src: str) -> str:
+    src = src.replace(
+        "{% if nav_item.children %}", "{% if nav_item.children and not nav_item.url %}"
+    )
+    # The above only for versions > 6.1.7, the below only for versions <= 6.1.7.
     return src.replace(
         "(nav_item.children | first).url",
         "(nav_item.url or (nav_item.children | first).url)",

diff --git a/tests/rewrites/material-nav-item-3.yml b/tests/rewrites/material-nav-item-3.yml
@@ -0,0 +1,152 @@
+# https://github.com/squidfunk/mkdocs-material/blob/d754bd9a7172e8afbfdcb505180776caf7c3c839/material/partials/nav-item.html
+input: |
+  {#-
+    This file was automatically generated - do not edit
+  -#}
+  {% set features = config.theme.features or [] %}
+  {% set class = "md-nav__item" %}
+  {% if nav_item.active %}
+    {% set class = class ~ " md-nav__item--active" %}
+  {% endif %}
+  {% if nav_item.children %}
+    {% if "navigation.sections" in features and level == 1 + (
+      "navigation.tabs" in features
+    ) %}
+      {% set class = class ~ " md-nav__item--section" %}
+    {% endif %}
+    <li class="{{ class }} md-nav__item--nested">
+      {% set checked = "checked" if nav_item.active %}
+      {% if "navigation.expand" in features and not checked %}
+        <input class="md-nav__toggle md-toggle" data-md-toggle="{{ path }}" data-md-state="indeterminate" type="checkbox" id="{{ path }}" checked>
+      {% else %}
+        <input class="md-nav__toggle md-toggle" data-md-toggle="{{ path }}" type="checkbox" id="{{ path }}" {{ checked }}>
+      {% endif %}
+      <label class="md-nav__link" for="{{ path }}">
+        {{ nav_item.title }}
+        <span class="md-nav__icon md-icon"></span>
+      </label>
+      <nav class="md-nav" aria-label="{{ nav_item.title }}" data-md-level="{{ level }}">
+        <label class="md-nav__title" for="{{ path }}">
+          <span class="md-nav__icon md-icon"></span>
+          {{ nav_item.title }}
+        </label>
+        <ul class="md-nav__list" data-md-scrollfix>
+          {% set base = path %}
+          {% for nav_item in nav_item.children %}
+            {% set path = base ~ "-" ~ loop.index %}
+            {% set level = level + 1 %}
+            {% include "partials/nav-item.html"  %}
+          {% endfor %}
+        </ul>
+      </nav>
+    </li>
+  {% elif nav_item == page %}
+    <li class="{{ class }}">
+      {% set toc = page.toc %}
+      <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+      {% if toc | first is defined and "\x3ch1 id=" in page.content %}
+        {% set toc = (toc | first).children %}
+      {% endif %}
+      {% if toc | first is defined %}
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+          {{ nav_item.title }}
+          <span class="md-nav__icon md-icon"></span>
+        </label>
+      {% endif %}
+      <a href="{{ nav_item.url | url }}" class="md-nav__link md-nav__link--active">
+        {{ nav_item.title }}
+      </a>
+      {% if toc | first is defined %}
+        {% include "partials/toc.html" %}
+      {% endif %}
+    </li>
+  {% else %}
+    <li class="{{ class }}">
+      <a href="{{ nav_item.url | url }}" class="md-nav__link">
+        {{ nav_item.title }}
+      </a>
+    </li>
+  {% endif %}
+output: |
+  {#-
+    This file was automatically generated - do not edit
+  -#}
+  {% set features = config.theme.features or [] %}
+  {% set class = "md-nav__item" %}
+  {% if nav_item.active %}
+    {% set class = class ~ " md-nav__item--active" %}
+  {% endif %}
+  {% if nav_item.children %}
+    {% if "navigation.sections" in features and level == 1 + (
+      "navigation.tabs" in features
+    ) %}
+      {% set class = class ~ " md-nav__item--section" %}
+    {% endif %}
+    <li class="{{ class }} md-nav__item--nested">
+      {% set checked = "checked" if nav_item.active %}
+      {% if "navigation.expand" in features and not checked %}
+        <input class="md-nav__toggle md-toggle" data-md-toggle="{{ path }}" data-md-state="indeterminate" type="checkbox" id="{{ path }}" checked>
+      {% else %}
+        <input class="md-nav__toggle md-toggle" data-md-toggle="{{ path }}" type="checkbox" id="{{ path }}" {{ checked }}>
+      {% endif %}
+      <label class="md-nav__link" for="{{ path }}">
+        <span class="md-nav__icon md-icon"></span>
+        {% if nav_item.url %}
+          <a href="{{ nav_item.url | url }}" class="md-nav__link{% if nav_item == page %} md-nav__link--active{% endif %}"
+            style="margin: initial; padding: initial; pointer-events: initial">
+        {% endif %}
+          {{ nav_item.title }}
+        {% if nav_item.url %}</a>{% endif %}
+      </label>
+      <nav class="md-nav" aria-label="{{ nav_item.title }}" data-md-level="{{ level }}">
+        <label class="md-nav__title" for="{{ path }}">
+          <span class="md-nav__icon md-icon"></span>
+          {% if nav_item.url %}
+            <a href="{{ nav_item.url | url }}" class="md-nav__link{% if nav_item == page %} md-nav__link--active{% endif %}"
+              style="margin: initial; padding: initial; pointer-events: initial">
+          {% endif %}
+            {{ nav_item.title }}
+          {% if nav_item.url %}</a>{% endif %}
+        </label>
+        <ul class="md-nav__list" data-md-scrollfix>
+          {% set base = path %}
+          {% for nav_item in nav_item.children %}
+            {% set path = base ~ "-" ~ loop.index %}
+            {% set level = level + 1 %}
+            {% include "partials/nav-item.html"  %}
+          {% endfor %}
+        </ul>
+      </nav>
+    </li>
+  {% elif nav_item == page %}
+    <li class="{{ class }}">
+      {% set toc = page.toc %}
+      <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+      {% if toc | first is defined and "\x3ch1 id=" in page.content %}
+        {% set toc = (toc | first).children %}
+      {% endif %}
+      {% if toc | first is defined %}
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+          <span class="md-nav__icon md-icon"></span>
+          {% if nav_item.url %}
+            <a href="{{ nav_item.url | url }}" class="md-nav__link{% if nav_item == page %} md-nav__link--active{% endif %}"
+              style="margin: initial; padding: initial; pointer-events: initial">
+          {% endif %}
+            {{ nav_item.title }}
+          {% if nav_item.url %}</a>{% endif %}
+        </label>
+      {% endif %}
+      <a href="{{ nav_item.url | url }}" class="md-nav__link md-nav__link--active">
+        {{ nav_item.title }}
+      </a>
+      {% if toc | first is defined %}
+        {% include "partials/toc.html" %}
+      {% endif %}
+    </li>
+  {% else %}
+    <li class="{{ class }}">
+      <a href="{{ nav_item.url | url }}" class="md-nav__link">
+        {{ nav_item.title }}
+      </a>
+    </li>
+  {% endif %}
diff --git a/tests/rewrites/material-tabs-item-2.yml b/tests/rewrites/material-tabs-item-2.yml
@@ -0,0 +1,59 @@
+# https://github.com/squidfunk/mkdocs-material/blob/d754bd9a7172e8afbfdcb505180776caf7c3c839/material/partials/tabs-item.html
+input: |
+  {#-
+    This file was automatically generated - do not edit
+  -#}
+  {% if not class %}
+    {% set class = "md-tabs__link" %}
+    {% if nav_item.active %}
+      {% set class = class ~ " md-tabs__link--active" %}
+    {% endif %}
+  {% endif %}
+  {% if nav_item.children %}
+    {% set title = title | d(nav_item.title) %}
+    {% set nav_item = nav_item.children | first %}
+    {% if nav_item.children %}
+      {% include "partials/tabs-item.html" %}
+    {% else %}
+      <li class="md-tabs__item">
+        <a href="{{ nav_item.url | url }}" class="{{ class }}">
+          {{ title }}
+        </a>
+      </li>
+    {% endif %}
+  {% else %}
+    <li class="md-tabs__item">
+      <a href="{{ nav_item.url | url }}" class="{{ class }}">
+        {{ nav_item.title }}
+      </a>
+    </li>
+  {% endif %}
+output: |
+  {#-
+    This file was automatically generated - do not edit
+  -#}
+  {% if not class %}
+    {% set class = "md-tabs__link" %}
+    {% if nav_item.active %}
+      {% set class = class ~ " md-tabs__link--active" %}
+    {% endif %}
+  {% endif %}
+  {% if nav_item.children and not nav_item.url %}
+    {% set title = title | d(nav_item.title) %}
+    {% set nav_item = nav_item.children | first %}
+    {% if nav_item.children and not nav_item.url %}
+      {% include "partials/tabs-item.html" %}
+    {% else %}
+      <li class="md-tabs__item">
+        <a href="{{ nav_item.url | url }}" class="{{ class }}">
+          {{ title }}
+        </a>
+      </li>
+    {% endif %}
+  {% else %}
+    <li class="md-tabs__item">
+      <a href="{{ nav_item.url | url }}" class="{{ class }}">
+        {{ nav_item.title }}
+      </a>
+    </li>
+  {% endif %}