a gentle amount of theming

ADBond · Jan 6, 2025 · 44c3746 · 44c3746
1 parent f886720
commit 44c3746
Show file tree

Hide file tree

Showing 4 changed files with 279 additions and 1 deletion.
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -0,0 +1,5 @@
+:root {
+    --md-primary-fg-color: #AA0000;
+    /* --md-primary-fg-color--light: #DDDDDD;
+    --md-primary-fg-color--dark: #00FF00; */
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,10 +1,39 @@
 site_name: Splinkclickhouse Documentation
+
 nav:
   - Home: index.md
   - Quickstart: quickstart.md
   - API:
     - Comparison and Comparison Level Library: api/libraries.md
-theme: readthedocs
+
+theme:
+  name: "material"
+  palette:
+    - scheme: default
+      primary: custom
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to dark mode
+    - scheme: slate
+      primary: custom
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to light mode
+  features:
+    - content.code.copy
+    - content.code.select
+extra_css:
+  - stylesheets/extra.css
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
 plugins:
   - search
   - mkdocstrings:

diff --git a/pyproject.toml b/pyproject.toml
@@ -70,6 +70,7 @@ chdb = [
 ]
 docs = [
     "mkdocs>=1.6.1",
+    "mkdocs-material>=9.5.49",
     "mkdocstrings-python>=1.13.0",
 ]