Split mkdocs configuration file (#1630)

Closes #1504

.github/workflows/pages.yml

@@ -51,7 +51,7 @@ jobs:
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          pipenv run mkdocs build
+          pipenv run mkdocs build --config-file mkdocs.production.yml
           mv .well-known site/
           pipenv run mkdocs --version
 

.github/workflows/preview.yml

@@ -43,4 +43,4 @@ jobs:
           build: |
             pip install pipenv
             pipenv install
-            pipenv run mkdocs build
+            pipenv run mkdocs build --config-file mkdocs.production.yml

README.md

@@ -82,7 +82,7 @@ This website uses [`mkdocs-material-insiders`](https://squidfunk.github.io/mkdoc
     - `git submodule init`
     - `git submodule update docs/assets/brand`
 2. Install [Python 3.6+](https://www.python.org/downloads/)
-3. Install [dependencies](/Pipfile): `pip install mkdocs mkdocs-material mkdocs-static-i18n mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin mkdocs-rss-plugin typing-extensions`
+3. Install [dependencies](/Pipfile): `pip install mkdocs mkdocs-material mkdocs-static-i18n typing-extensions`
 4. Serve the site locally: `mkdocs serve`
     - The site will be available at `http://localhost:8000`
     - You can build the site locally with `mkdocs build`
@@ -91,10 +91,10 @@ This website uses [`mkdocs-material-insiders`](https://squidfunk.github.io/mkdoc
 **Team members** should clone the repository with `mkdocs-material-insiders` directly. This method is identical to production:
 
 1. Clone this repository and submodules: `git clone --recurse-submodules https://github.com/privacyguides/privacyguides.org.git`
-2. Install [Python 3.6+](https://www.python.org/downloads/)
+2. Install Python **3.7**
 3. Install **pipenv**: `pip install pipenv`
 4. Install dependencies: `pipenv install --dev`
-5. Serve the site locally: `pipenv run mkdocs serve`
+5. Serve the site locally: `pipenv run mkdocs serve --config-file mkdocs.production.yml`
     - The site will be available at `http://localhost:8000`
     - You can build the site locally with `pipenv run mkdocs build`
     - This version of the site should be identical to the live, production version

mkdocs.production.yml

@@ -0,0 +1,70 @@
+INHERIT: mkdocs.yml
+plugins:
+  minify:
+    minify_html: true
+    htmlmin_opts:
+        remove_comments: true
+  privacy:
+    externals_exclude:
+      - cdn.jsdelivr.net/npm/mathjax@3/*
+      - api.privacyguides.net/*
+      - giscus.app/*
+  git-committers:
+    repository: privacyguides/privacyguides.org
+    branch: main
+    token: !ENV GH_TOKEN
+  git-revision-date-localized:
+      exclude:
+        - index.en.md
+  rss:
+    match_path: "blog/.*"
+    pretty_print: true
+    date_from_meta:
+      as_creation: "created"
+      datetime_format: "%Y-%m-%d"
+
+extra:
+  generator: false
+  analytics:
+    provider: plausible
+    property: privacyguides.org
+    feedback:
+      title: Was this page helpful?
+      ratings:
+        - icon: hero/emoji-happy
+          name: This page was helpful
+          data: Helpful
+          note: Thanks for your feedback!
+        - icon: hero/emoji-sad
+          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>.
+
+theme:
+  features:
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.sections
+    - content.tooltips
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: hero/sparkles
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      accent: amber
+      toggle:
+        icon: hero/moon
+        name: Switch to system theme
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      accent: deep purple
+      toggle:
+        icon: hero/sun
+        name: Switch to dark mode
+
+watch:
+  - theme
+  - includes
+  - mkdocs.yml

mkdocs.yml

@@ -11,21 +11,6 @@ copyright: |
   This content was made available by the Privacy Guides team and contributors. <a href="https://github.com/privacyguides/privacyguides">Get involved</a>!
 
 extra:
-  generator: false
-  analytics:
-    provider: plausible
-    property: privacyguides.org
-    feedback:
-      title: Was this page helpful?
-      ratings:
-        - icon: hero/emoji-happy
-          name: This page was helpful
-          data: Helpful
-          note: Thanks for your feedback!
-        - icon: hero/emoji-sad
-          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
@@ -57,97 +42,74 @@ theme:
     - navigation.tracking
     - navigation.tabs
     - navigation.sections
-    - content.tooltips
   palette:
-    - media: "(prefers-color-scheme: light)"
+    - scheme: default
-      scheme: default
       accent: deep purple
       toggle:
         icon: hero/sun
         name: Switch to dark mode
-    - media: "(prefers-color-scheme: dark)"
+    - scheme: slate
-      scheme: slate
       accent: amber
       toggle:
         icon: hero/moon
         name: Switch to light mode
+
 watch:
   - theme
   - includes
 
 plugins:
-  - minify:
+  i18n:
-      minify_html: true
+    default_language: en
-      htmlmin_opts:
+    material_alternate: true
-          remove_comments: true
+    languages:
-  - i18n:
+      en:
-      default_language: en
+        name: English
-      material_alternate: true
+        build: false
-      languages:
+  tags: {}
-        en:
+  search: {}
-          name: English
+
-          build: false
+markdown_extensions:
-  - tags
+  admonition: {}
-  - search
+  pymdownx.details: {}
-  - git-revision-date-localized:
+  pymdownx.superfences:
-      exclude:
+    custom_fences:
-        - index.en.md
+      - name: mermaid
-  - rss:
+        class: mermaid
-      match_path: "blog/.*"
+        format: !!python/name:pymdownx.superfences.fence_code_format
-      pretty_print: true
+  pymdownx.tabbed:
-      date_from_meta:
+    alternate_style: true
-        as_creation: "created"
+  pymdownx.arithmatex:
-        datetime_format: "%Y-%m-%d"
+    generic: true
-  - privacy:
+  pymdownx.critic: {}
-      externals_exclude:
+  pymdownx.caret: {}
-        - cdn.jsdelivr.net/npm/mathjax@3/*
+  pymdownx.keys: {}
-        - api.privacyguides.net/*
+  pymdownx.mark: {}
-        - giscus.app/*
+  pymdownx.tilde: {}
-  - git-committers:
+  pymdownx.snippets:
-      repository: privacyguides/privacyguides.org
+    auto_append:
-      branch: main
+      - includes/abbreviations.en.md
-      token: !ENV GH_TOKEN
+  pymdownx.tasklist:
+    custom_checkbox: true
+  attr_list: {}
+  def_list: {}
+  md_in_html: {}
+  meta: {}
+  abbr: {}
+  pymdownx.emoji:
+    emoji_index: !!python/name:materialx.emoji.twemoji
+    emoji_generator: !!python/name:materialx.emoji.to_svg
+    options:
+      custom_icons:
+        - theme/.icons
+  tables: {}
+  footnotes: {}
+  toc:
+    permalink: true
+    toc_depth: 4
+
 extra_css:
   - assets/stylesheets/extra.css?v=2.10.0
-markdown_extensions:
-  - admonition
-  - pymdownx.details
-  - pymdownx.superfences:
-      custom_fences:
-        - name: mermaid
-          class: mermaid
-          format: !!python/name:pymdownx.superfences.fence_code_format
-  - pymdownx.tabbed:
-      alternate_style: true
-  - pymdownx.arithmatex:
-      generic: true
-  - pymdownx.critic
-  - pymdownx.caret
-  - pymdownx.keys
-  - pymdownx.mark
-  - pymdownx.tilde
-  - pymdownx.snippets:
-      auto_append:
-        - includes/abbreviations.en.md
-  - pymdownx.tasklist:
-      custom_checkbox: true
-  - attr_list
-  - def_list
-  - md_in_html
-  - meta
-  - abbr
-  - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
-      options:
-        custom_icons:
-          - theme/.icons
-  - tables
-  - footnotes
-  - toc:
-      permalink: true
-      toc_depth: 4
-
 extra_javascript:
   - assets/javascripts/mathjax.js
   - assets/javascripts/feedback.js