{% block content %} {% if page.edit_url %} @@ -183,10 +183,18 @@ {% include "partials/footer.html" %} {% endblock %}

- {% block scripts %} - - - {%- set translations = {} -%} +

+ {% block config %} + {%- set app = { + "base": base_url, + "features": features, + "translations": {}, + "search": "assets/javascripts/workers/search.217ffd95.min.js" | url, + "version": config.extra.version or None + } -%} + {%- set translations = app.translations -%} {%- for key in [ "clipboard.copy", "clipboard.copied", @@ -204,19 +212,12 @@ ] -%} {%- set _ = translations.update({ key: lang.t(key) }) -%} {%- endfor -%} - - {% block config %}{% endblock %} - + {% endblock %} + {% block scripts %} + {% for path in config["extra_javascript"] %} {% endfor %} ``` === ":octicons-file-code-16: partials/footer.html" ``` diff -

- {% if page.previous_page %} - - {% endif %} - {% if page.next_page %} -

+ {% include ".icons/material/arrow-right.svg" %} +

+ + {% endif %} + {% endif %}

``` === ":octicons-file-code-16: partials/header.html" ``` diff @@ -6,21 +6,21 @@ {% set site_url = site_url ~ "/index.html" %} {% endif %}

- +

+ {% include "partials/logo.html" %} - + {% include ".icons/material/menu" ~ ".svg" %} -

{% if page and page.meta and page.meta.title %} {{ page.meta.title }} @@ -31,14 +31,35 @@

+ {% if config.extra.alternate %} +

+ {% set icon = config.theme.icon.alternate or "material/translate" %} + + {% include ".icons/" ~ icon ~ ".svg" %} + +

+ + {{ alt.name }} + +

+ {% endif %} +

{% if "search" in config["plugins"] %} - + {% include ".icons/material/magnify.svg" %} {% include "partials/search.html" %} {% endif %} {% if config.repo_url %} -

{% include "partials/source.html" %}

{% endif %} ``` === ":octicons-file-code-16: partials/source.html" ``` diff @@ -4,5 +4,5 @@ {% import "partials/language.html" as lang with context %} - +

{% set icon = config.theme.icon.repo or "fontawesome/brands/git-alt" %} {% include ".icons/" ~ icon ~ ".svg" %} ``` === ":octicons-file-code-16: partials/toc.html" ``` diff @@ -12,7 +12,7 @@ {{ lang.t("toc.title") }} -

{% for toc_item in toc %} {% include "partials/toc-item.html" %} {% endfor %} ``` ## Upgrading from 5.x to 6.x ### What's new? - Improved search result look and feel - Improved search result stability while typing - Improved search result grouping (pages + headings) - Improved search result relevance and scoring - Added display of missing query terms to search results - Reduced size of vendor bundle by 25% (84kb → 67kb) - Reduced size of the Docker image to improve CI build performance - Removed hero partial in favor of custom implementation - Removed deprecated front matter features ### Changes to `mkdocs.yml` Following is a list of changes that need to be made to `mkdocs.yml`. Note that you only have to adjust the value if you defined it, so if your configuration does not contain the key, you can skip it. #### `theme.features` All feature flags that can be set from `mkdocs.yml`, like [tabs] and [instant loading], are now prefixed with the name of the component or function they apply to, e.g. `navigation.*`: === "6.x" ``` yaml theme: features: - navigation.tabs - navigation.instant ``` === "5.x" ``` yaml theme: features: - tabs - instant ``` [tabs]: setup/setting-up-navigation.md#navigation-tabs [instant loading]: setup/setting-up-navigation.md#instant-loading ### Changes to `*.html` files { data-search-exclude } The templates have undergone a set of changes to make them future-proof. If you've used theme extension to override a block or template, make sure that it matches the new structure: - If you've overridden a __block__, check `base.html` for potential changes - If you've overridden a __template__, check the respective `*.html` file for potential changes === ":octicons-file-code-16: base.html" ``` diff @@ -22,13 +22,6 @@ {% import "partials/language.html" as lang with context %} - -{% set palette = config.theme.palette %} -{% if not palette is mapping %} - {% set palette = palette | first %} -{% endif %} -{% set font = config.theme.font %} - @@ -45,21 +38,8 @@ {% endif %} - - {% if page and page.meta and page.meta.redirect %} - - - - - - - - {% elif page.canonical_url %} + {% if page.canonical_url %} {% endif %} @@ -96,20 +76,21 @@ - {% if palette.scheme or palette.primary or palette.accent %} + {% if config.theme.palette %} + {% set palette = config.theme.palette %} - {% endif %} - - {% if palette.primary %} - {% import "partials/palette.html" as map %} - {% set primary = map.primary( - palette.primary | replace(" ", "-") | lower - ) %} - + + {% if palette.primary %} + {% import "partials/palette.html" as map %} + {% set primary = map.primary( + palette.primary | replace(" ", "-") | lower + ) %} + + {% endif %} {% endif %} {% endblock %} @@ -120,7 +101,8 @@ {% block fonts %} - {% if font != false %} + {% if config.theme.font != false %} + {% set font = config.theme.font %} {% set direction = config.theme.direction or lang.t('direction') %} - {% if palette.scheme or palette.primary or palette.accent %} - {% set scheme = palette.scheme | lower %} + {% if config.theme.palette %} + {% set palette = config.theme.palette %} + {% if not palette is mapping %} + {% set palette = palette | first %} + {% endif %} + {% set scheme = palette.scheme | replace(" ", "-") | lower %} {% set primary = palette.primary | replace(" ", "-") | lower %} {% set accent = palette.accent | replace(" ", "-") | lower %} + + + {% if "preference" == scheme %} + + {% endif %} + {% else %} {% endif %} - - {% if "preference" == palette.scheme %} - - {% endif %} - - {% block hero %} - {% if page and page.meta and page.meta.hero %} - {% include "partials/hero.html" with context %} - {% endif %} - {% endblock %} + {% block hero %}{% endblock %} {% block tabs %} - {% if "tabs" in config.theme.features %} + {% if "navigation.tabs" in config.theme.features %} {% include "partials/tabs.html" %} {% endif %} {% endblock %} @@ -310,13 +293,6 @@