Merge pull request #3109 from embik/mkdocs-update

📖 Update documentation dependencies and add dark mode
kcp-dev · Apr 3, 2024 · b46e66f · b46e66f
2 parents 99732c3 + 4e89688
commit b46e66f
Show file tree

Hide file tree

Showing 29 changed files with 180 additions and 29 deletions.
diff --git a/docs/OWNERS b/docs/OWNERS
diff --git a/docs/content/.pages b/docs/content/.pages
@@ -1,3 +1,6 @@
 nav:
-- Home: index.md
-- ...
+  - Home:
+    - index.md
+    - CONTRIBUTING.md
+    - GOALS.md
+  - ...
diff --git a/docs/content/index.md b/docs/content/index.md
@@ -1,4 +1,4 @@
-# <img src="logo.png" style="vertical-align: middle;" /> kcp Documentation
+# kcp Documentation
 
 ## Overview
 

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: kcp Documentation
+site_name: docs.kcp.io
 repo_url: https://github.com/kcp-dev/kcp
 site_url: https://docs.kcp.io/kcp/
 
@@ -15,18 +15,48 @@ theme:
   features:
     # Enable navigation section index pages, so we don't see Concepts > Concepts
     - navigation.indexes
+    # Enable navigation tabs so we can group content by persona
+    - navigation.tabs
     # Enable a copy button in code blocks
     - content.code.copy
     # Enable annotations on specific lines in code blocks
     - content.code.annotate
-  logo: logo.png
+  logo: logo.svg
   favicon: favicons/favicon.ico
+  palette:
+  # Palette toggle for automatic mode
+  - media: "(prefers-color-scheme)"
+    toggle:
+      icon: material/brightness-auto
+      name: Switch to light mode
+
+  # Palette toggle for light mode
+  - media: "(prefers-color-scheme: light)"
+    scheme: default 
+    primary: white
+    toggle:
+      icon: material/brightness-7
+      name: Switch to dark mode
+
+  # Palette toggle for dark mode
+  - media: "(prefers-color-scheme: dark)"
+    scheme: slate
+    primary: black
+    toggle:
+      icon: material/brightness-4
+      name: Switch to system preference
 
 extra:
   version:
     # Enable mike for multi-version selection
     provider: mike
 
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/kcp-dev/kcp
+    - icon: fontawesome/brands/slack
+      link: https://kubernetes.slack.com/archives/C021U8WSAFK
+
 plugins:
   # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
   # Greater control over how navigation links are shown
@@ -39,10 +69,15 @@ plugins:
       module_name: 'main'
   # Configure multiple language support
   - i18n:
-      default_language: en
+      docs_structure: suffix
+      fallback_to_default: true
       languages:
-        en:
+        - build: true
+          default: true
+          locale: en
           name: English
+      reconfigure_material: true
+      reconfigure_search: true
 
 markdown_extensions:
   # Code block highlighting
@@ -58,10 +93,6 @@ markdown_extensions:
   # Enable note/warning/etc. callouts
   - admonition
 
-# Our CSS
-extra_css:
-  - stylesheets/kcp.css
-
 # Live reload if any of these change when running 'mkdocs serve'
 watch:
   - mkdocs.yml

diff --git a/docs/overrides/favicons/android-144x144.png b/docs/overrides/favicons/android-144x144.png
diff --git a/docs/overrides/favicons/android-192x192.png b/docs/overrides/favicons/android-192x192.png
diff --git a/docs/overrides/favicons/android-36x36.png b/docs/overrides/favicons/android-36x36.png
diff --git a/docs/overrides/favicons/android-48x48.png b/docs/overrides/favicons/android-48x48.png
diff --git a/docs/overrides/favicons/android-72x72.png b/docs/overrides/favicons/android-72x72.png
diff --git a/docs/overrides/favicons/android-96x96.png b/docs/overrides/favicons/android-96x96.png
diff --git a/docs/overrides/favicons/android-chrome-192x192.png b/docs/overrides/favicons/android-chrome-192x192.png
diff --git a/docs/overrides/favicons/android-chrome-512x512.png b/docs/overrides/favicons/android-chrome-512x512.png
diff --git a/docs/overrides/favicons/apple-touch-icon-180x180.png b/docs/overrides/favicons/apple-touch-icon-180x180.png
diff --git a/docs/overrides/favicons/apple-touch-icon.png b/docs/overrides/favicons/apple-touch-icon.png
diff --git a/docs/overrides/favicons/favicon-1024.png b/docs/overrides/favicons/favicon-1024.png
diff --git a/docs/overrides/favicons/favicon-16x16.png b/docs/overrides/favicons/favicon-16x16.png
diff --git a/docs/overrides/favicons/favicon-256.png b/docs/overrides/favicons/favicon-256.png
diff --git a/docs/overrides/favicons/favicon-32x32.png b/docs/overrides/favicons/favicon-32x32.png
diff --git a/docs/overrides/favicons/favicon.ico b/docs/overrides/favicons/favicon.ico
diff --git a/docs/overrides/favicons/mstile-150x150.png b/docs/overrides/favicons/mstile-150x150.png
diff --git a/docs/overrides/favicons/pwa-192x192.png b/docs/overrides/favicons/pwa-192x192.png
diff --git a/docs/overrides/favicons/pwa-512x512.png b/docs/overrides/favicons/pwa-512x512.png
diff --git a/docs/overrides/favicons/tile150x150.png b/docs/overrides/favicons/tile150x150.png
diff --git a/docs/overrides/favicons/tile310x310.png b/docs/overrides/favicons/tile310x310.png
diff --git a/docs/overrides/favicons/tile70x70.png b/docs/overrides/favicons/tile70x70.png
diff --git a/docs/overrides/logo.png b/docs/overrides/logo.png
diff --git a/docs/overrides/logo.svg b/docs/overrides/logo.svg
diff --git a/docs/overrides/partials/outdated.html b/docs/overrides/partials/outdated.html
@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block outdated %}
+  You're not viewing the latest version.
+  <a href="{{ '../' ~ base_url }}"> 
+    <strong>Click here to go to latest.</strong>
+  </a>
+{% endblock %}
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,12 +1,7 @@
-Jinja2==3.1.2
-Markdown==3.3.7
-MarkupSafe==2.1.2
-mike==1.1.2
-mkdocs==1.4.2
-mkdocs-awesome-pages-plugin==2.8.0
-mkdocs-macros-plugin==0.7.0
-mkdocs-material==9.1.0
-mkdocs-material-extensions==1.1.1
-mkdocs-static-i18n==0.53
-Pygments==2.14.0
-pymdown-extensions==9.9.2
+mike==2.0.0
+mkdocs==1.5.3
+mkdocs-awesome-pages-plugin==2.9.2
+mkdocs-macros-plugin==1.0.5
+mkdocs-material==9.5.17
+mkdocs-material-extensions==1.3.1
+mkdocs-static-i18n==1.2.2