Add features tied to Royal Gold funding goal

material/base.html

@@ -22,7 +22,7 @@
         <link rel="canonical" href="{{ page.canonical_url }}">
       {% endif %}
       <link rel="icon" href="{{ config.theme.favicon | url }}">
-      <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.3.9">
+      <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.4.0rc1">
     {% endblock %}
     {% block htmltitle %}
       {% if page.meta and page.meta.title %}
@@ -34,7 +34,7 @@
       {% endif %}
     {% endblock %}
     {% block styles %}
-      <link rel="stylesheet" href="{{ 'assets/stylesheets/main.1df838e0.min.css' | url }}">
+      <link rel="stylesheet" href="{{ 'assets/stylesheets/main.69437709.min.css' | url }}">
       {% if config.theme.palette %}
         {% set palette = config.theme.palette %}
         <link rel="stylesheet" href="{{ 'assets/stylesheets/palette.cbb835fc.min.css' | url }}">
@@ -102,21 +102,29 @@
       {% if self.announce() %}
         <aside class="md-banner">
           <div class="md-banner__inner md-grid md-typeset">
+            {% if "announce.dismiss" in features %}
+              <button class="md-banner__button md-icon" aria-label="{{ lang.t('announce.dismiss') }}">
+                {% include ".icons/material/close.svg" %}
+              </button>
+            {% endif %}
             {% block announce %}{% endblock %}
           </div>
+          {% if "announce.dismiss" in features %}
+            {% include "partials/javascripts/announce.html" %}
+          {% endif %}
         </aside>
       {% endif %}
     </div>
     {% if config.extra.version %}
       <div data-md-component="outdated" hidden>
-        <aside class="md-banner md-banner--warning">
-          {% if self.outdated() %}
+        {% if self.outdated() %}
+          <aside class="md-banner md-banner--warning">
             <div class="md-banner__inner md-grid md-typeset">
               {% block outdated %}{% endblock %}
             </div>
             {% include "partials/javascripts/outdated.html" %}
-          {% endif %}
-        </aside>
+          </aside>
+        {% endif %}
       </div>
     {% endif %}
     {% block header %}
@@ -182,6 +190,17 @@
     <div class="md-dialog" data-md-component="dialog">
       <div class="md-dialog__inner md-typeset"></div>
     </div>
+    {% if config.extra.consent %}
+      <div class="md-consent" data-md-component="consent" id="__consent" hidden>
+        <div class="md-consent__overlay"></div>
+        <aside class="md-consent__inner">
+          <form class="md-consent__form md-grid md-typeset" name="consent">
+            {% include "partials/consent.html" %}
+          </form>
+        </aside>
+      </div>
+      {% include "partials/javascripts/consent.html" %}
+    {% endif %}
     {% block config %}
       {%- set app = {
         "base": base_url,
@@ -216,7 +235,7 @@
       </script>
     {% endblock %}
     {% block scripts %}
-      <script src="{{ 'assets/javascripts/bundle.1236fc65.min.js' | url }}"></script>
+      <script src="{{ 'assets/javascripts/bundle.9c69f0bc.min.js' | url }}"></script>
       {% for path in config["extra_javascript"] %}
         <script src="{{ path | url }}"></script>
       {% endfor %}

material/overrides/main.html

@@ -19,5 +19,5 @@
 {% endblock %}
 {% block scripts %}
   {{ super() }}
-  <script src="{{ 'overrides/assets/javascripts/bundle.d71dce94.min.js' | url }}"></script>
+  <script src="{{ 'overrides/assets/javascripts/bundle.a163e2c4.min.js' | url }}"></script>
 {% endblock %}

material/overrides/partials/content.html

@@ -24,3 +24,4 @@ <h1>{{ page.title | d(config.site_name, true)}}</h1>
 ) %}
   {% include "partials/source-file.html" %}
 {% endif %}
+{% include "partials/feedback.html" %}

material/partials/consent.html

@@ -0,0 +1,56 @@
+{#-
+  This file was automatically generated - do not edit
+-#}
+{% import "partials/language.html" as lang with context %}
+{% set cookies = config.extra.consent.cookies %}
+{% if config.extra.analytics and not cookies %}
+  {% set cookies = { "analytics": "Google Analytics" } %}
+{% endif %}
+{% set actions = config.extra.consent.actions %}
+{% if not actions %}
+  {% set actions = ["accept", "manage"] %}
+{% endif %}
+<h4>{{ config.extra.consent.title }}</h4>
+<p>{{ config.extra.consent.description }}</p>
+<input type="checkbox" class="md-toggle" id="__settings">
+<div class="md-consent__settings">
+  <ul class="task-list">
+    {% for type in cookies %}
+      {% if cookies[type] is string %}
+        {% set name = cookies[type] %}
+        {% set checked = "checked" %}
+      {% else %}
+        {% set name = cookies[type].name %}
+        {% if cookies[type].checked %}
+          {% set checked = "checked" %}
+        {% endif %}
+      {% endif %}
+      <li class="task-list-item">
+        <label class="task-list-control">
+          <input type="checkbox" name="{{ type }}" {{ checked }}>
+          <span class="task-list-indicator"></span>
+          {{ name }}
+        <label>
+      </li>
+    {% endfor %}
+  </ul>
+</div>
+<div class="md-consent__controls">
+  {% for action in actions %}
+    {% if action == "accept" %}
+      <button class="md-button md-button--primary">
+        {{- lang.t("consent.accept") -}}
+      </button>
+    {% endif %}
+    {% if action == "reject" %}
+      <button type="reset" class="md-button md-button--primary">
+        {{- lang.t("consent.reject") -}}
+      </button>
+    {% endif %}
+    {% if action == "manage" %}
+      <label class="md-button" for="__settings">
+        {{- lang.t("consent.manage") -}}
+      </label>
+    {% endif %}
+  {% endfor %}
+</div>

material/partials/content.html

@@ -19,3 +19,4 @@ <h1>{{ page.title | d(config.site_name, true)}}</h1>
 ) %}
   {% include "partials/source-file.html" %}
 {% endif %}
+{% include "partials/feedback.html" %}

material/partials/feedback.html

@@ -0,0 +1,46 @@
+{#-
+  This file was automatically generated - do not edit
+-#}
+{% if config.extra.analytics %}
+  {% set feedback = config.extra.analytics.feedback %}
+{% endif %}
+{% if page and page.meta and page.meta.hide %}
+  {% if "feedback" in page.meta.hide %}
+    {% set feedback = None %}
+  {% endif %}
+{% endif %}
+{% if feedback %}
+  <form class="md-feedback" name="feedback" hidden>
+    <fieldset>
+      <legend class="md-feedback__title">
+        {{ feedback.title }}
+      </legend>
+      <div class="md-feedback__inner">
+        <div class="md-feedback__list">
+          {% for rating in feedback.ratings %}
+            <button class="md-feedback__icon md-icon" type="submit" title="{{ rating.name }}" data-md-value="{{ rating.data }}">
+              {% include ".icons/" ~ rating.icon ~ ".svg" %}
+            </button>
+          {% endfor %}
+        </div>
+        <div class="md-feedback__note">
+          {% for rating in feedback.ratings %}
+            <div data-md-value="{{ rating.data }}" hidden>
+              {% set url = "/" ~ page.url %}
+              {% if page and page.meta and page.meta.title %}
+                {% set title = page.meta.title | urlencode %}
+              {% else %}
+                {% set title = page.title | urlencode %}
+              {% endif %}
+              {% if "{}" in rating.note %}
+                {{ rating.note.format(url, title) }}
+              {% else %}
+                {{ rating.note.format(url = url, title = title) }}
+              {% endif %}
+            </div>
+          {% endfor %}
+        </div>
+      </div>
+    </fieldset>
+  </form>
+{% endif %}

material/partials/integrations/analytics.html

@@ -6,4 +6,9 @@
 {% endif %}
 {% if provider %}
   {% include "partials/integrations/analytics/" ~ provider ~ ".html" %}
+  {% if config.extra.consent %}
+    <script>var consent;"undefined"==typeof __md_analytics||(consent=__md_get("__consent"))&&consent.analytics&&__md_analytics()</script>
+  {% else %}
+    <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
+  {% endif %}
 {% endif %}

material/partials/integrations/analytics/google.html

@@ -5,9 +5,7 @@
   {% set property = config.extra.analytics.property | d("", true) %}
 {% endif %}
 {% if property.startswith("G-") %}
-  <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","{{ property }}"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","{{ property }}",{page_path:e.pathname})})})</script>
-  <script async src="https://www.googletagmanager.com/gtag/js?id={{ property }}"></script>
+  <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","{{ property }}"),document.addEventListener("DOMContentLoaded",function(){if(document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document.forms.feedback){var e,a=document.forms.feedback;for(e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}"undefined"!=typeof location$&&location$.subscribe(function(e){n("config","{{ property }}",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id={{ property }}",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
 {% elif property.startswith("UA-") %}
-  <script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","{{ property }}","auto"),ga("set","anonymizeIp",!0),ga("send","pageview"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){var e;this.value&&(e=document.location.pathname,ga("send","pageview",e+"?q="+this.value))}),"undefined"!=typeof location$&&location$.subscribe(function(e){ga("send","pageview",e.pathname)})})</script>
-  <script async src="https://www.google-analytics.com/analytics.js"></script>
+  <script id="__analytics">function __md_analytics(){window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","{{ property }}","auto"),ga("set","anonymizeIp",!0),ga("send","pageview"),document.addEventListener("DOMContentLoaded",function(){if(document.forms.search&&document.forms.search.query.addEventListener("blur",function(){var e;this.value&&(e=document.location.pathname,ga("send","pageview",e+"?q="+this.value))}),document.forms.feedback){var e,a=document.forms.feedback;for(e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");ga("send","event","feedback","click",t,e),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}"undefined"!=typeof location$&&location$.subscribe(function(e){ga("send","pageview",e.pathname)})});var e=document.createElement("script");e.async=!0,e.src="https://www.google-analytics.com/analytics.js",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
 {% endif %}

material/partials/javascripts/announce.html

@@ -0,0 +1,4 @@
+{#-
+  This file was automatically generated - do not edit
+-#}
+<script>var content,el=document.querySelector("[data-md-component=announce]");el&&(content=el.querySelector(".md-typeset"),__md_hash(content.innerHTML)===__md_get("__announce")&&(el.hidden=!0))</script>

material/partials/javascripts/base.html

@@ -1,4 +1,4 @@
 {#-
   This file was automatically generated - do not edit
 -#}
-<script>__md_scope=new URL("{{ config.extra.scope | d(base_url) }}",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+<script>__md_scope=new URL("{{ config.extra.scope | d(base_url) }}",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>

material/partials/javascripts/consent.html

@@ -0,0 +1,4 @@
+{#-
+  This file was automatically generated - do not edit
+-#}
+<script>var consent=__md_get("__consent");if(consent)for(var input of document.forms.consent.elements)input.name&&(input.checked=consent[input.name]||!1);else"file:"!==location.protocol&&setTimeout(function(){document.querySelector("[data-md-component=consent]").hidden=!1},250);var action,form=document.forms.consent;for(action of["submit","reset"])form.addEventListener(action,function(e){if(e.preventDefault(),"reset"===e.type)for(var n of document.forms.consent.elements)n.name&&(n.checked=!1);console.log(new FormData(form)),__md_set("__consent",Object.fromEntries(Array.from(new FormData(form).keys()).map(function(e){return[e,!0]}))),location.hash="",location.reload()})</script>

material/partials/languages/de.html

@@ -3,8 +3,12 @@
 -#}
 {% macro t(key) %}{{ {
   "language": "de",
+  "announce.dismiss": "Nicht mehr anzeigen",
   "clipboard.copy": "In Zwischenablage kopieren",
   "clipboard.copied": "In Zwischenablage kopiert",
+  "consent.accept": "Akzeptieren",
+  "consent.manage": "Einstellungen",
+  "consent.reject": "Ablehnen",
   "edit.link.title": "Seite editieren",
   "footer.previous": "Zurück",
   "footer.next": "Weiter",

material/partials/languages/en.html

@@ -4,8 +4,12 @@
 {% macro t(key) %}{{ {
   "language": "en",
   "direction": "ltr",
+  "announce.dismiss": "Don't show this again",
   "clipboard.copy": "Copy to clipboard",
   "clipboard.copied": "Copied to clipboard",
+  "consent.accept": "Accept",
+  "consent.manage": "Manage settings",
+  "consent.reject": "Reject",
   "edit.link.title": "Edit this page",
   "footer.previous": "Previous",
   "footer.next": "Next",

material/partials/languages/es.html

@@ -5,6 +5,8 @@
   "language": "es",
   "clipboard.copy": "Copiar al portapapeles",
   "clipboard.copied": "Copiado al portapapeles",
+  "consent.accept": "Aceptar",
+  "consent.manage": "Gestionar cookies",
   "edit.link.title": "Editar esta página",
   "footer.previous": "Anterior",
   "footer.next": "Siguiente",

material/partials/languages/fr.html

@@ -5,6 +5,9 @@
   "language": "fr",
   "clipboard.copy": "Copier dans le presse-papier",
   "clipboard.copied": "Copié dans le presse-papier",
+  "consent.accept": "Accepter",
+  "consent.manage": "Paramétrer vos choix",
+  "consent.reject": "Refuser",
   "edit.link.title": "Editer cette page",
   "footer.previous": "Précédent",
   "footer.next": "Suivant",

material/partials/languages/sv.html

@@ -5,6 +5,8 @@
   "language": "sv",
   "clipboard.copy": "Kopiera till urklipp",
   "clipboard.copied": "Kopierat till urklipp",
+  "consent.accept": "Acceptera",
+  "consent.manage": "Hantera inställningar",
   "edit.link.title": "Redigera sidan",
   "footer.previous": "Föregående",
   "footer.next": "Nästa",

material/partials/languages/zh-TW.html

@@ -3,8 +3,12 @@
 -#}
 {% macro t(key) %}{{ {
   "language": "zh-Hant",
+  "announce.dismiss": "不再顯示此訊息",
   "clipboard.copy": "複製",
   "clipboard.copied": "已複製",
+  "consent.accept": "同意",
+  "consent.manage": "管理設定",
+  "consent.reject": "拒絕",
   "edit.link.title": "編輯此頁",
   "footer.previous": "上一頁",
   "footer.next": "下一頁",

mkdocs.yml

@@ -49,6 +49,7 @@ theme:
   # Default values, taken from mkdocs_theme.yml
   language: en
   features:
+    # - announce.dismiss
     - content.code.annotate
     # - content.tabs.link
     - content.tooltips
@@ -104,9 +105,30 @@ plugins:
 
 # Customization
 extra:
+  consent:
+    title: Cookie consent
+    description: >-
+      We use cookies to recognize your repeated visits and preferences, as well
+      as to measure the effectiveness of our documentation and whether users
+      find what they're searching for. With your consent, you're helping us to
+      make our documentation better.
   analytics:
     provider: google
-    property: !ENV GOOGLE_ANALYTICS_KEY
+    property: UA-12345 #!ENV GOOGLE_ANALYTICS_KEY
+    feedback:
+      title: Was this page helpful?
+      ratings:
+        - icon: material/emoticon-happy-outline
+          name: This page was helpful
+          data: 1
+          note: >-
+            Thanks for your feedback!
+        - icon: material/emoticon-sad-outline
+          name: This page could be improved
+          data: 0
+          note: >- # !
+            Thanks for your feedback! Help us improve this page by
+            using our <a href="..." target=_blank>feedback form</a>.
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/squidfunk