Optimization for Material theme / tabbed: don't render navs of other tabs

When a tab has a section index page, and it is not the currently selected tab, skip rendering its sub-items entirely.

On desktop view this makes no difference, but in mobile view you will no longer be able to navigate out of the current tab and directly into sub-items of another tab -- first you'll have to navigate to the index page of the other tab.

So this is basically a downgrade, but for large sites this is also a huge optimization in terms of build time and disk usage.

Author: oprypin

mkdocs_section_index/rewrites.py

@@ -42,6 +42,11 @@ def get_source(self, environment: Environment, template: str) -> Tuple[str, str,
 
 
 def _transform_material_nav_item_template(src: str) -> str:
+    src = src.replace(
+        "{% if nav_item.children %}",
+        "{% if nav_item.children and not ('navigation.tabs' in features and level == 1 and not nav_item.active and nav_item.url) %}",
+    )
+
     repl = """\
         {% if nav_item.url %}
           <a href="{{ nav_item.url | url }}" class="md-nav__link{% if nav_item == page %} md-nav__link--active{% endif %}"

tests/rewrites/material-nav-item-1.yml

@@ -74,7 +74,7 @@ output: |
   {% if nav_item.active %}
     {% set class = "md-nav__item md-nav__item--active" %}
   {% endif %}
-  {% if nav_item.children %}
+  {% if nav_item.children and not ('navigation.tabs' in features and level == 1 and not nav_item.active and nav_item.url) %}
     <li class="{{ class }} md-nav__item--nested">
       {% if nav_item.active %}
         <input class="md-nav__toggle md-toggle" data-md-toggle="{{ path }}" type="checkbox" id="{{ path }}" checked>

tests/rewrites/material-nav-item-2.yml

@@ -65,7 +65,7 @@ output: |
   {% if nav_item.active %}
     {% set class = "md-nav__item md-nav__item--active" %}
   {% endif %}
-  {% if nav_item.children %}
+  {% if nav_item.children and not ('navigation.tabs' in features and level == 1 and not nav_item.active and nav_item.url) %}
     <li class="{{ class }} md-nav__item--nested">
       {% set checked = "checked" if nav_item.active %}
       <input class="md-nav__toggle md-toggle" data-md-toggle="{{ path }}" type="checkbox" id="{{ path }}" {{ checked }}>

tests/rewrites/material-nav-item-3.yml

@@ -76,7 +76,7 @@ output: |
   {% if nav_item.active %}
     {% set class = class ~ " md-nav__item--active" %}
   {% endif %}
-  {% if nav_item.children %}
+  {% if nav_item.children and not ('navigation.tabs' in features and level == 1 and not nav_item.active and nav_item.url) %}
     {% if "navigation.sections" in features and level == 1 + (
       "navigation.tabs" in features
     ) %}