Merge pull request #40 from CABLE-LSM/31-use-snippets-to-avoid-replic…

…ating-readmemd-content-to-indexmd Added snippet. Fixes #31
CABLE-LSM · Jun 25, 2024 · 97369a2 · 97369a2
2 parents 6264ad5 + 7a934e5
commit 97369a2
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 6 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1 @@
-# meorg_client
-
-The meorg_client (hereafter referred to as the Client) is a piece of software positioned between the [benchcab](https://github.com/CABLE-LSM/benchcab) testing framework and the [ModelEvaluation.org](https://modelevaluation.org) model evaluation service. The Client replaces the formerly manual process of uploading model output from benchcab to ModelEvaluation.org through the use of a Python library and command-line interface (CLI).
+--8<-- "README.md"
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,7 +1,24 @@
 site_name: meorg_client
 
-theme: material
+theme:
+  name: material
+  palette:
+    - scheme: light
+      primary: blue
+      accent: deep orange
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+    - scheme: slate
+      primary: blue
+      accent: deep orange
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
 
 plugins:
-- search
-- mkdocstrings
+  - search
+  - mkdocstrings
+
+markdown_extensions:
+  - pymdownx.snippets