Add material plugin

exercism · Jan 23, 2024 · 4cc529d · 4cc529d
1 parent a4da349
commit 4cc529d
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1 @@
+../CONTRIBUTING.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,3 @@
-# Index
+# Welcome to exercism/java-analyzer
 
 Welcome to the Exercism Java analyzer documentation! 👋
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,6 +9,26 @@ edit_uri: blob/main/docs/
 
 copyright: 'Copyright &copy; 2024 Exercism'
 
+theme:
+  name: material
+  palette:
+    # Palette toggle for light mode
+    - scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    # Palette toggle for dark mode
+    - scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - navigation.path
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
+    - navigation.tracking
+
 markdown_extensions:
   - admonition
   - fenced_code
@@ -19,3 +39,4 @@ markdown_extensions:
 
 nav:
   - Home: index.md
+  - contributing.md