Update mkdocs-material-insiders (#2449)

privacyguides · Mar 28, 2024 · 525a2c1 · 525a2c1
1 parent c5bdbbc
commit 525a2c1
Show file tree

Hide file tree

Showing 25 changed files with 142 additions and 137 deletions.
diff --git a/.cache/plugin/social/fonts/Bagnard/Bold.woff b/.cache/plugin/social/fonts/Bagnard/Bold.woff
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -34,7 +34,7 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "monthly"
     assignees:
       - "jonaharagon"
     reviewers:
@@ -48,7 +48,7 @@ updates:
     registries:
       - github-privacyguides
     schedule:
-      interval: "daily"
+      interval: "monthly"
     labels:
       - "fix:submodules"
 

diff --git a/.github/workflows/crowdin-upload.yml b/.github/workflows/crowdin-upload.yml
@@ -39,7 +39,7 @@ jobs:
       uses: actions/checkout@v4
 
     - name: crowdin action
-      uses: crowdin/[email protected].0
+      uses: crowdin/[email protected].1
       with:
         upload_sources: true
         upload_sources_args: '--auto-update --delete-obsolete'

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -105,7 +105,7 @@ jobs:
           image: ghcr.io/openzim/zim-tools:3.1.3
           options: -v ${{ github.workspace }}:/data
           run: |
-            zimwriterfs -w index.html -I assets/brand/PNG/Square/pg-yellow.png -l eng -t "Privacy Guides" -d "Your central privacy and security resource to protect yourself online." -c "Privacy Guides" -p "Jonah Aragon" -n "Privacy Guides" -e "https://github.com/privacyguides/privacyguides.org" /data/site /data/privacy_guides.zim
+            zimwriterfs -w index.html -I assets/brand/logos/png/square/pg-yellow.png -l eng -t "Privacy Guides" -d "Your central privacy and security resource to protect yourself online." -c "Privacy Guides" -p "Jonah Aragon" -n "Privacy Guides" -e "https://github.com/privacyguides/privacyguides.org" /data/site /data/privacy_guides.zim
 
       - name: Upload ZIM file
         uses: actions/upload-artifact@v4

diff --git a/.gitignore b/.gitignore
@@ -6,17 +6,17 @@ site
 !/static/i18n/*.en.*
 /theme/overrides/*
 !/theme/overrides/*.en.*
-# include Bagnard font in social card
-# (not available in Google Fonts)
+# commit social card fonts to repo
+# see: https://github.com/squidfunk/mkdocs-material/issues/6983
 # ridiculous hide-and-seek https://stackoverflow.com/a/72380673
-/.cache/*
-!/.cache/plugin
-/.cache/plugin/*
-!/.cache/plugin/social
-/.cache/plugin/social/*
-!/.cache/plugin/social/fonts
-/.cache/plugin/social/fonts/*
-!/.cache/plugin/social/fonts/Bagnard
+.cache/*
+!/config/.cache
+/config/.cache/*
+!/config/.cache/plugin
+/config/.cache/plugin/*
+!/config/.cache/plugin/social
+/config/.cache/plugin/social/*
+!/config/.cache/plugin/social/fonts
 
 # Editor settings
 .vscode/*

diff --git a/Pipfile b/Pipfile
@@ -27,7 +27,7 @@ name = "pypi"
 mkdocs-material = {path = "./modules/mkdocs-material"}
 mkdocs-git-revision-date-localized-plugin = "~=1.2"
 mkdocs-git-committers-plugin-2 = "~=1.1"
-mkdocs-macros-plugin = "~=0.7"
+mkdocs-macros-plugin = "~=1.0"
 pillow = "~=10.0"
 cairosvg = "~=2.7"
 

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/config/.cache/plugin/social/fonts b/config/.cache/plugin/social/fonts
@@ -0,0 +1 @@
+../../../../theme/assets/brand/fonts
diff --git a/config/layouts/home.yml b/config/layouts/home.yml
@@ -23,7 +23,7 @@ definitions:
 
   - &page_title_with_site_name >-
     {{ page.meta.get("title", page.title) }}
-  
+
   - &page_description >-
     {{ config.extra.homepage_description or "A socially motivated website which provides information about protecting your online data privacy and security." }}
 
@@ -83,7 +83,7 @@ layers:
       font:
         family: *title_font_family
         style: Bold
-  
+
   # Page description
   - size: { width: 864, height: 192 }
     offset: { x: 64, y: 320 }

diff --git a/config/layouts/page.yml b/config/layouts/page.yml
@@ -56,7 +56,7 @@ definitions:
 
   - &logo >-
     {%- if page.meta.cover -%}
-      theme/assets/brand/SVG/Logo/privacy-guides-logo-notext.svg
+      theme/assets/brand/logos/svg/logo/privacy-guides-logo-notext.svg
     {%- elif config.theme.logo -%}
       {{ config.docs_dir }}/{{ config.theme.logo }}
     {%- endif -%}

diff --git a/config/layouts/pride.yml b/config/layouts/pride.yml
@@ -4,7 +4,7 @@ definitions:
     {%- if page.meta.cover -%}
       theme/assets/img/cover/{{ page.meta.cover }}
     {%- else -%}
-      {{ layout.background_image or "theme/assets/brand/PNG/Banner/cover-progress-notext-blur.png" }}
+      {{ layout.background_image or "theme/assets/brand/images/png/cover-progress-notext-blur.png" }}
     {%- endif -%}
 
   - &background_color >-
@@ -51,7 +51,7 @@ definitions:
     {{ page.meta.icon or "" }}
 
   - &logo >-
-    theme/assets/brand/SVG/Logo/privacy-guides-logo-notext.svg
+    theme/assets/brand/logos/svg/logo/privacy-guides-logo-notext.svg
 
 # Meta tags
 tags:

diff --git a/config/mkdocs-common.yml b/config/mkdocs-common.yml
@@ -77,8 +77,8 @@ repo_name: ""
 theme:
   name: material
   custom_dir: ../theme
-  logo: ../../theme/assets/brand/SVG/Logo/privacy-guides-logo-notext-colorbg.svg
-  favicon: assets/brand/png/favicon/favicon-32x32.png
+  logo: ../../theme/assets/brand/logos/svg/logo/privacy-guides-logo-notext-colorbg.svg
+  favicon: assets/brand/logos/png/favicon-32x32.png
   icon:
     repo: simple/github
   features:
@@ -156,8 +156,8 @@ markdown_extensions:
   meta: {}
   abbr: {}
   pymdownx.emoji:
-    emoji_index: !!python/name:materialx.emoji.twemoji
-    emoji_generator: !!python/name:materialx.emoji.to_svg
+    emoji_index: !!python/name:material.extensions.emoji.twemoji
+    emoji_generator: !!python/name:material.extensions.emoji.to_svg
   tables: {}
   footnotes: {}
   toc:

diff --git a/config/mkdocs-offline.yml b/config/mkdocs-offline.yml
@@ -43,7 +43,7 @@ extra:
 theme:
   language: en
   # this logo needs to be set separately because the relative path is different
-  logo: ../theme/assets/brand/SVG/Logo/privacy-guides-logo-notext-colorbg.svg
+  logo: ../theme/assets/brand/logos/svg/logo/privacy-guides-logo-notext-colorbg.svg
   font:
     text: Public Sans
     code: DM Mono
@@ -82,7 +82,7 @@ plugins:
 
 markdown_extensions:
   pymdownx.snippets:
-    auto_append: 
+    auto_append:
       - includes/abbreviations.en.txt
 
 nav:

diff --git a/config/mkdocs.en.yml b/config/mkdocs.en.yml
@@ -40,7 +40,7 @@ extra:
 theme:
   language: en
   # ENGLISH ONLY: this logo needs to be set separately because the relative path is different
-  logo: ../theme/assets/brand/SVG/Logo/privacy-guides-logo-notext-colorbg.svg
+  logo: ../theme/assets/brand/logos/svg/logo/privacy-guides-logo-notext-colorbg.svg
   font:
     text: Public Sans
     code: DM Mono
@@ -66,7 +66,7 @@ theme:
 
 markdown_extensions:
   pymdownx.snippets:
-    auto_append: 
+    auto_append:
       - includes/abbreviations.en.txt
 
 nav:

diff --git a/docs/about/index.md b/docs/about/index.md
@@ -7,7 +7,7 @@ schema:
   "@id": https://www.privacyguides.org/
   name: Privacy Guides
   url: https://www.privacyguides.org/en/about/
-  logo: https://www.privacyguides.org/en/assets/brand/png/square/pg-yellow.png
+  logo: https://www.privacyguides.org/en/assets/brand/logos/png/square/pg-yellow.png
   sameAs:
     - https://twitter.com/privacy_guides
     - https://github.com/privacyguides
@@ -16,7 +16,7 @@ schema:
     - https://www.youtube.com/@privacyguides
     - https://mastodon.neat.computer/@privacyguides
 ---
-![Privacy Guides logo](../assets/brand/PNG/Square/pg-yellow.png){ align=right }
+![Privacy Guides logo](../assets/brand/logos/png/square/pg-yellow.png){ align=right }
 
 **Privacy Guides** is a socially motivated website that provides [information](/kb) for protecting your data security and privacy. Our mission is to inform the public about the value of digital privacy, and global government initiatives which aim to monitor your online activity. We are a non-profit collective operated entirely by volunteer [team members](https://discuss.privacyguides.net/g/team) and contributors. Our website is free of advertisements and not affiliated with any of the listed providers.
 

diff --git a/docs/index.md b/docs/index.md
@@ -14,7 +14,7 @@ schema:
     "@id": https://www.privacyguides.org/
     name: Privacy Guides
     url: https://www.privacyguides.org/en/about/
-    logo: https://www.privacyguides.org/en/assets/brand/png/square/pg-yellow.png
+    logo: https://www.privacyguides.org/en/assets/brand/logos/png/square/pg-yellow.png
     sameAs:
       - https://twitter.com/privacy_guides
       - https://github.com/privacyguides

diff --git a/modules/mkdocs-material b/modules/mkdocs-material
diff --git a/theme/assets/brand b/theme/assets/brand
diff --git a/theme/assets/files/meta/browserconfig.xml b/theme/assets/files/meta/browserconfig.xml
@@ -2,7 +2,7 @@
 <browserconfig>
     <msapplication>
         <tile>
-            <square150x150logo src="/assets/brand/PNG/Favicon/mstile-150x150.png"/>
+            <square150x150logo src="/en/assets/brand/logos/png/mstile-150x150.png"/>
             <TileColor>#ffd06f</TileColor>
         </tile>
     </msapplication>

diff --git a/theme/assets/files/meta/site.webmanifest b/theme/assets/files/meta/site.webmanifest
@@ -3,12 +3,12 @@
     "short_name": "Privacy Guides",
     "icons": [
         {
-            "src": "/assets/brand/PNG/Favicon/android-chrome-192x192.png",
+            "src": "/en/assets/brand/logos/png/android-chrome-192x192.png",
             "sizes": "192x192",
             "type": "image/png"
         },
         {
-            "src": "/assets/brand/PNG/Favicon/android-chrome-512x512.png",
+            "src": "/en/assets/brand/logos/png/android-chrome-192x192.png",
             "sizes": "512x512",
             "type": "image/png"
         }