mkdocs-primer 0.2.0__tar.gz → 0.3.0__tar.gz

{mkdocs_primer-0.2.0 → mkdocs_primer-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mkdocs-primer
-Version: 0.2.0
+Version: 0.3.0
 Summary: A MkDocs theme built on GitHub's Primer design system
 Project-URL: Homepage, https://github.com/olegshulyakov/mkdocs-primer
 Project-URL: Source, https://github.com/olegshulyakov/mkdocs-primer
@@ -121,13 +121,14 @@ This precaches the generated site for offline use after the first visit. Service
 The demo site doubles as the theme's plugin compatibility test: `mkdocs.yml` enables every plugin that needs something from a theme, and CI builds it with `--strict`.
 Those plugins need Python 3.10+, so CI checks the theme's own floor of 3.9 against a plugin-free site.
 
-A few plugins cannot share that config — `rss` and `gen-files` both break under `static-i18n` — so they get their own sites under `examples/`, published beside the main one.
+A few plugins cannot share that config — `rss` and `gen-files` both break under `static-i18n`, and Mermaid breaks under `minify_html` — so they get their own sites under `examples/`, published beside the main one and described on the [Examples](https://olegshulyakov.github.io/mkdocs-primer/examples/) page.
 Build them after it, since `mkdocs build` cleans `site/`:
 
 ```console
 $ mkdocs build --strict
 $ mkdocs build --strict -f examples/rss/mkdocs.yml
 $ mkdocs build --strict -f examples/gen-files/mkdocs.yml
+$ mkdocs build --strict -f examples/diagrams/mkdocs.yml
 ```
 
 ## License

{mkdocs_primer-0.2.0 → mkdocs_primer-0.3.0}/README.md

@@ -95,13 +95,14 @@ This precaches the generated site for offline use after the first visit. Service
 The demo site doubles as the theme's plugin compatibility test: `mkdocs.yml` enables every plugin that needs something from a theme, and CI builds it with `--strict`.
 Those plugins need Python 3.10+, so CI checks the theme's own floor of 3.9 against a plugin-free site.
 
-A few plugins cannot share that config — `rss` and `gen-files` both break under `static-i18n` — so they get their own sites under `examples/`, published beside the main one.
+A few plugins cannot share that config — `rss` and `gen-files` both break under `static-i18n`, and Mermaid breaks under `minify_html` — so they get their own sites under `examples/`, published beside the main one and described on the [Examples](https://olegshulyakov.github.io/mkdocs-primer/examples/) page.
 Build them after it, since `mkdocs build` cleans `site/`:
 
 ```console
 $ mkdocs build --strict
 $ mkdocs build --strict -f examples/rss/mkdocs.yml
 $ mkdocs build --strict -f examples/gen-files/mkdocs.yml
+$ mkdocs build --strict -f examples/diagrams/mkdocs.yml
 ```
 
 ## License

{mkdocs_primer-0.2.0 → mkdocs_primer-0.3.0}/mkdocs_primer/base.html

@@ -141,9 +141,15 @@
     <div class="primer-layout{{ ' primer-layout-with-sidebar' if show_sidebar }}">
       {%- block site_nav %}
         {%- if show_sidebar %}
-          <aside class="primer-sidebar" aria-label="{% trans %}Site navigation{% endtrans %}">
+          {#
+            A plain box: the column holds the navigation and nothing else, and
+            the name now sits on the <nav> inside it. As an <aside> it was a
+            complementary landmark wrapping a navigation landmark, and a screen
+            reader announced the same name twice on the way in.
+          #}
+          <div class="primer-sidebar">
             {% include "partials/nav.html" %}
-          </aside>
+          </div>
         {%- endif %}
       {%- endblock %}
 
@@ -231,6 +237,7 @@
       <script src="{{ 'js/back-to-top.js' | url }}" defer></script>
       <script src="{{ 'js/scrollable.js' | url }}" defer></script>
       <script src="{{ 'js/nav-sections.js' | url }}" defer></script>
+      <script src="{{ 'js/toc-collapse.js' | url }}" defer></script>
       <script src="{{ 'js/toc-active.js' | url }}" defer></script>
       {# Unconditional: the language and navigation popovers exist with or without search. #}
       <script src="{{ 'js/disclosure.js' | url }}" defer></script>