Enable new mkdocs-material features (#2451)

Signed-off-by: Daniel Gray <dngray@privacyguides.org>

config/mkdocs-common.yml

@@ -28,22 +28,139 @@ site_description:
     SITE_DESCRIPTION,
     "Privacy Guides is your central privacy and security resource to protect yourself online.",
   ]
-copyright:
-  !ENV [FOOTER_COPYRIGHT, "© 2019 Privacy Guides and contributors."]
-edit_uri: edit/main/docs/
+edit_uri_template: blob/main/docs/{path}?plain=1
 
 extra:
   generator: false
   context: !ENV [CONTEXT, "production"]
   deploy: !ENV DEPLOY_ID
-  homepage_description:
-    !ENV [
-      DESCRIPTION_HOMEPAGE,
-      "A socially motivated website which provides information about protecting your online data privacy and security.",
-    ]
-  translation_notice: !ENV DESCRIPTION_TRANSLATION
-  translation_notice_cta: !ENV [DESCRIPTION_TRANSLATION_CTA, "Visit Crowdin"]
-  translation_notice_language: !ENV LANG_ENGLISH
+  privacy_guides:
+    footer:
+      intro:
+        !ENV [
+          FOOTER_INTRO,
+          "Privacy Guides is a non-profit, socially motivated website that provides information for protecting your data security and privacy.",
+        ]
+      note:
+        !ENV [
+          FOOTER_NOTE,
+          "We do not make money from recommending certain products, and we do not use affiliate links.",
+        ]
+      copyright:
+        author:
+          !ENV [FOOTER_COPYRIGHT_AUTHOR, "Privacy Guides and contributors."]
+        date: !ENV [FOOTER_COPYRIGHT_DATE, "2019-2024"]
+      license:
+        - fontawesome/brands/creative-commons
+        - fontawesome/brands/creative-commons-by
+        - fontawesome/brands/creative-commons-nd
+      analytics: !ENV [FOOTER_ANALYTICS, "Anonymous statistics preferences."]
+    homepage:
+      description:
+        !ENV [
+          HOMEPAGE_DESCRIPTION,
+          "A socially motivated website which provides information about protecting your online data privacy and security.",
+        ]
+      hero:
+        header:
+          !ENV [HOMEPAGE_HEADER, "The guide to restoring your online privacy."]
+        subheader:
+          !ENV [
+            HOMEPAGE_SUBHEADER,
+            "Massive organizations are monitoring your online activities. Privacy Guides is your central privacy and security resource to protect yourself online.",
+          ]
+        buttons:
+          - name:
+              !ENV [
+                HOMEPAGE_BUTTON_GET_STARTED_NAME,
+                "Start Your Privacy Journey",
+              ]
+            title:
+              !ENV [
+                HOMEPAGE_BUTTON_GET_STARTED_TITLE,
+                "The first step of your privacy journey",
+              ]
+            link: basics/why-privacy-matters/
+            class: md-button md-button--primary
+          - name: !ENV [HOMEPAGE_BUTTON_TOOLS_NAME, "Recommended Tools"]
+            title:
+              !ENV [
+                HOMEPAGE_BUTTON_TOOLS_TITLE,
+                "Recommended privacy tools, services, and knowledge",
+              ]
+            link: tools/
+            class: md-button
+      cta:
+        - title:
+            !ENV [
+              HOMEPAGE_CTA_TITLE,
+              "We need you! Here's how to get involved:",
+            ]
+          links:
+            - icon: simple/discourse
+              name: !ENV [HOMEPAGE_CTA_FORUM_NAME, "Join the forum"]
+              link: https://discuss.privacyguides.net/
+            - icon: simple/mastodon
+              name: !ENV [HOMEPAGE_CTA_MASTODON_NAME, "Follow us on Mastodon"]
+              link: https://mastodon.neat.computer/@privacyguides
+            - icon: simple/github
+              name: !ENV [HOMEPAGE_CTA_GITHUB_NAME, "Contribute on GitHub"]
+              link: https://github.com/privacyguides/privacyguides.org
+            - icon: material/translate
+              name: !ENV [HOMEPAGE_CTA_TRANSLATE_NAME, "Help translate"]
+              link: https://crowdin.com/project/privacyguides
+            - icon: simple/matrix
+              name: !ENV [HOMEPAGE_CTA_MATRIX_NAME, "Join the Matrix chat"]
+              link: https://matrix.to/#/#privacyguides:matrix.org
+            - icon: material/information-outline
+              name: !ENV [HOMEPAGE_CTA_ABOUT_NAME, "Learn more about us"]
+              link: about/
+            - icon: material/hand-coin
+              name: !ENV [HOMEPAGE_CTA_DONATE_NAME, "Donate to Privacy Guides"]
+              link: about/donate/
+          description:
+            !ENV [
+              HOMEPAGE_CTA_DESCRIPTION,
+              "If you spot an error, think a provider should not be listed, notice a qualified provider is missing, believe a browser plugin is no longer the best choice, or uncover any other issue, please let us know.",
+            ]
+      rss:
+        - title:
+            !ENV [
+              HOMEPAGE_RSS_CHANGELOG_TITLE,
+              "Privacy Guides release changelog",
+            ]
+          link:
+            !ENV [
+              HOMEPAGE_RSS_CHANGELOG_LINK,
+              "https://discuss.privacyguides.net/c/site-development/changelog/9.rss",
+            ]
+        - title: !ENV [HOMEPAGE_RSS_BLOG_TITLE, "Privacy Guides blog feed"]
+          link:
+            !ENV [
+              HOMEPAGE_RSS_BLOG_LINK,
+              "https://blog.privacyguides.org/feed_rss_created.xml",
+            ]
+        - title:
+            !ENV [HOMEPAGE_RSS_STORIES_TITLE, "Privacy Guides Web Stories feed"]
+          link:
+            !ENV [
+              HOMEPAGE_RSS_STORIES_LINK,
+              "https://share.privacyguides.org/web-stories/feed/",
+            ]
+        - title:
+            !ENV [
+              HOMEPAGE_RSS_FORUM_TITLE,
+              "Latest Privacy Guides forum topics",
+            ]
+          link:
+            !ENV [
+              HOMEPAGE_RSS_FORUM_LINK,
+              "https://discuss.privacyguides.net/latest.rss",
+            ]
+    translation_notice:
+      notice: !ENV TRANSLATION_NOTICE
+      cta: !ENV [TRANSLATION_NOTICE_CTA, "Visit Crowdin"]
+      language: !ENV LANG_ENGLISH
   social:
     - icon: simple/mastodon
       link: https://mastodon.neat.computer/@privacyguides
@@ -95,19 +212,22 @@ extra:
       icon: https://raw.githubusercontent.com/twitter/twemoji/master/assets/svg/1f1f7-1f1fa.svg
   analytics:
     feedback:
-      title: Was this page helpful?
+      title: !ENV [ANALYTICS_FEEDBACK_TITLE, "Was this page helpful?"]
       ratings:
         - icon: material/emoticon-happy-outline
-          name: This page was helpful
+          name: !ENV [ANALYTICS_FEEDBACK_POSITIVE_NAME, "This page was helpful"]
           data: 1
-          note: >-
-            Thanks for your feedback!
+          note:
+            !ENV [ANALYTICS_FEEDBACK_POSITIVE_NOTE, "Thanks for your feedback!"]
         - icon: material/emoticon-sad-outline
-          name: This page could be improved
+          name:
+            !ENV [
+              ANALYTICS_FEEDBACK_NEGATIVE_NAME,
+              "This page could be improved",
+            ]
           data: 0
-          note: >-
-            Thanks for your feedback! If you want to let us know more, please leave a post on our
-            <a href="https://discuss.privacyguides.net/c/site-development/7" target="_blank" rel="noopener">forum</a>.
+          note:
+            !ENV [ANALYTICS_FEEDBACK_NEGATIVE_NOTE, "Thanks for your feedback!"]
   consent:
     title: !ENV [ANALYTICS_CONSENT_TITLE, "Contribute anonymous statistics"]
     description:
@@ -167,6 +287,7 @@ theme:
     - navigation.expand
     - navigation.path
     - navigation.indexes
+    - content.action.edit
     - content.tabs.link
     - content.tooltips
     - search.highlight
@@ -212,6 +333,10 @@ plugins:
 
 markdown_extensions:
   admonition: {}
+  material.extensions.preview:
+    sources:
+      exclude:
+        - tools.md
   pymdownx.details: {}
   pymdownx.superfences:
     custom_fences: