Update mkdocs-material-insiders (#1147)

.github/workflows/deploy.yml

@@ -18,11 +18,15 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: '0'
+          ref: ${{github.event.pull_request.head.ref}}
+          repository: ${{github.event.pull_request.head.repo.full_name}}
+          ssh-key: ${{ secrets.ACTIONS_SSH_KEY }}
+          submodules: 'true'
 
       - name: Set up Python runtime
         uses: actions/setup-python@v3
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
+          python-version: '3.7'
       
       - name: Cache files
         uses: actions/cache@v3.0.2
@@ -32,24 +36,15 @@ jobs:
 
       - name: Install Python dependencies
         run: |
-          pip install 'mkdocs>=1.3.0'
+          pip install pipenv
-          pip install mkdocs-static-i18n
+          pipenv install
-          pip install mkdocs-git-revision-date-localized-plugin
-
-      - name: Install mkdocs-material Insiders build
-        if: github.event.repository.fork == false
-        env:
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
-        run: |
-          git clone --depth 1 https://${GH_TOKEN}@github.com/privacyguides/mkdocs-material-insiders.git
-          pip install -e mkdocs-material-insiders
 
       - name: Build website
         run: |
-          mkdocs build
+          pipenv run mkdocs build
           mv .well-known site/
           tar cvf site.tar site
-          mkdocs --version
+          pipenv run mkdocs --version
 
       - name: Package website
         uses: actions/upload-artifact@v3

Pipfile.lock

@@ -111,11 +111,11 @@
         },
         "click": {
             "hashes": [
-                "sha256:24e1a4a9ec5bf6299411369b208c1df2188d9eb8d916302fe6bf03faed227f1e",
+                "sha256:7682dc8afb30297001674575ea00d1814d808d6a36af415a82bd481d37ba7b8e",
-                "sha256:479707fe14d9ec9a0757618b7a100a0ae4c4e236fac5b7f80ca68028141a1a72"
+                "sha256:bb4d8133cb15a609f44e8213d9b391b0809795062913b383c62be0ee95b1db48"
             ],
             "markers": "python_version >= '3.7'",
-            "version": "==8.1.2"
+            "version": "==8.1.3"
         },
         "cssselect2": {
             "hashes": [
@@ -327,7 +327,7 @@
         },
         "mkdocs-material": {
             "path": "./mkdocs-material",
-            "version": "==8.2.8+insiders.4.12.0"
+            "version": "==8.2.11+insiders.4.13.1"
         },
         "mkdocs-material-extensions": {
             "hashes": [
@@ -339,10 +339,10 @@
         },
         "mkdocs-static-i18n": {
             "hashes": [
-                "sha256:0d97df64b5be7b34dc112d4ccfba28352b9fccd1b7a3babf229f30d25f6ebb36"
+                "sha256:5d69b4eb284931bd048a36f923367f2a7bd0dc7b0438008dce8ca1a8feee99e2"
             ],
             "index": "pypi",
-            "version": "==0.44"
+            "version": "==0.45"
         },
         "packaging": {
             "hashes": [
@@ -405,11 +405,11 @@
         },
         "pygments": {
             "hashes": [
-                "sha256:5eb116118f9612ff1ee89ac96437bb6b49e8f04d8a13b514ba26f620208e26eb",
+                "sha256:44238f1b60a76d78fc8ca0528ee429702aae011c265fe6a8dd8b63049ae41c65",
-                "sha256:dc9c10fb40944260f6ed4c688ece0cd2048414940f1cea51b8b226318411c519"
+                "sha256:4e426f72023d88d03b2fa258de560726ce890ff3b630f88c21cbb8b2503b8c6a"
             ],
-            "markers": "python_version >= '3.6'",
+            "markers": "python_version >= '3.5'",
-            "version": "==2.12.0"
+            "version": "==2.11.2"
         },
         "pymdown-extensions": {
             "hashes": [

docs/browsers.en.md

@@ -1,6 +1,9 @@
 ---
 title: "Web Browsers"
 icon: octicons/browser-16
+tags:
+  - HTML5
+  - JavaScript
 ---
 These are our current web browser recommendations and settings. We recommend keeping extensions to a minimum: they have privileged access within your browser, require you to trust the developer, can make you [stand out](https://en.wikipedia.org/wiki/Device_fingerprint#Browser_fingerprint), and [weaken](https://groups.google.com/a/chromium.org/g/chromium-extensions/c/0ei-UCHNm34/m/lDaXwQhzBAAJ) site isolation.
 

docs/index.en.md

@@ -3,6 +3,7 @@ template: overrides/home.en.html
 hide:
   - navigation
   - toc
+  - feedback
 ---
 <!-- markdownlint-disable-next-line -->
 <div style="max-width:50rem;margin:auto;" markdown>

docs/javascripts/feedback.js

@@ -0,0 +1,23 @@
+var feedback = document.forms.feedback
+/* Show feedback */
+feedback.hidden = false
+feedback.addEventListener("submit", function(ev) {
+  ev.preventDefault()
+
+  /* Retrieve page and feedback value */
+  var page = document.location.pathname
+  var data = ev.submitter.getAttribute("data-md-value")
+
+  /* Send feedback value */
+  console.log(page, data)
+  plausible(data)
+
+  /* Disable form and show note, if given */
+  feedback.firstElementChild.disabled = true
+  var note = feedback.querySelector(
+    ".md-feedback__note [data-md-value='" + data + "']"
+  )
+
+  if (note)
+    note.hidden = false
+})

docs/stylesheets/extra.css

@@ -61,7 +61,7 @@
 }
 
 /* Define brand */
-:root {
+:root, [data-md-color-scheme="default"] {
     --md-primary-fg-color:        #FFD06F;
     --md-primary-fg-color--light: #ffdd98;
     --md-primary-fg-color--dark:  #db9d21;
@@ -78,7 +78,7 @@
 }
 
 /* Better contrast link colors */
-[data-md-color-scheme="default"] {
+[data-md-color-scheme="default"] > * {
     --md-typeset-a-color: #3C00E0;
 }
 

docs/technology/dns.en.md

@@ -131,7 +131,7 @@ Server Name Indication is typically used when a IP address hosts many websites.
 
 2. Then we visit [https://privacyguides.org](https://privacyguides.org).
 
-3. After visiting the website, we what to stop the packet capture with <kbd>CTRL</kbd> + <kbd>C</kbd>.
+3. After visiting the website, we want to stop the packet capture with <kbd>CTRL</kbd> + <kbd>C</kbd>.
 
 4. Next we want to analyze the results:
 

mkdocs.yml

@@ -15,6 +15,17 @@ extra:
   analytics:
     provider: plausible
     property: privacyguides.org
+    feedback:
+      title: Was this page helpful?
+      ratings:
+        - icon: material/emoticon-happy-outline
+          name: This page was helpful
+          data: Helpful
+          note: Thanks for your feedback!
+        - icon: material/emoticon-sad-outline
+          name: This page could be improved
+          data: Needs Improvement
+          note: Thanks for your feedback! Help us improve this page by opening a <a href="https://github.com/orgs/privacyguides/discussions" target=_blank>discusson on GitHub</a>.
   social:
     - icon: pg/matrix
       link: https://matrix.to/#/#privacyguides:matrix.org
@@ -120,6 +131,7 @@ markdown_extensions:
 
 extra_javascript:
   - javascripts/mathjax.js
+  - javascripts/feedback.js
 
 nav:
   - Home: 'index.md'

theme/partials/integrations/analytics/plausible.html

@@ -1 +1,2 @@
 <script defer data-domain="{{ config.extra.analytics.property }}" src="https://stats.privacyguides.net/js/plausible.js"></script>
+<script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>