Update docs, add syntax highlighting

EcoExtreML · Aug 8, 2023 · e49d0de · e49d0de
1 parent dee6566
commit e49d0de
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 7 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,10 @@
+# Zampy
+
+A tool for downloading Land Surface Model input data.
+
+### Name origin
+
+Named after *Zam*; [the Avestan language term for the Zoroastrian concept of "earth"](https://en.wikipedia.org/wiki/Zam).
+
+## How to use Zampy
+See the section ["using Zampy"](using_zampy.md).
diff --git a/docs/using_zampy.md b/docs/using_zampy.md
@@ -2,7 +2,7 @@
 
 ## Installing Zampy
 Zampy can be installed by doing:
-```sh
+```bash
 pip install zampy git+https://github.com/EcoExtreML/zampy
 ```
 
@@ -13,26 +13,28 @@ This file is created under your -*user's home*-/.config directory:
 
 `~/.config/zampy/zampy_config.yml`
 
-```yml
+```yaml
 working_directory: /home/bart/Zampy
-
 ```
 
 ## Formulating a recipe
 Recipes have the following structure:
 
-```yml
+```yaml
 name: "test_recipe"
 
 download:
-  years: [2019, 2020]
+  years: [2020, 2020]
   bbox: [54, 6, 50, 3] # NESW
 
   datasets:
     era5:
       variables:
         - 10m_v_component_of_wind
         - surface_pressure
+    eth_canopy_height:
+      variables:
+        - height_of_vegetation
 
 convert:
   convention: ALMA
@@ -45,7 +47,7 @@ You can specify multiple datasets and multiple variables per dataset.
 ## Running a recipe
 Save this recipe to disk and run the following code in your shell:
 
-```sh
+```bash
 zampy --filename /home/username/path_to_file/simple_recipe.yml
 ```
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,11 +2,17 @@ site_name: Zampy Documentation
 
 theme:
   name: material
+  highlightjs: true
+  hljs_languages:
+    - yaml
+    - python
+    - bash
   features:
   - navigation.instant
   - navigation.tabs
   - navigation.tabs.sticky
-
+  - content.code.copy
+
   palette:
     # Palette toggle for light mode
     - scheme: default
@@ -38,5 +44,14 @@ plugins:
             merge_init_into_class: yes
             show_submodules: no
 
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
 extra:
   generator: false