diff --git a/docs/index.md b/docs/index.md index ba01551..4ab0748 100644 --- 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). \ No newline at end of file +--8<-- "README.md" \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 4bc8ace..11fb610 100644 --- 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 \ No newline at end of file + - search + - mkdocstrings + +markdown_extensions: + - pymdownx.snippets \ No newline at end of file