mkdocs.yml

acrlabs · Nov 14, 2023 · c9c8e5e · c9c8e5e
1 parent 124c95a
commit c9c8e5e
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
+---
+project: SimKube
+description: foo bar baz
+template: docs.html
+---
+
 ![build status](https://github.com/acrlabs/simkube/actions/workflows/verify.yml/badge.svg)
 
 # simkube

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -0,0 +1,12 @@
+nav:
+  - Home: README.md
+  - Usage:
+    - Components:
+      - sk-cloudprov: docs/sk_cloudprov.md
+      - sk-tracer: docs/sk_tracer.md
+      - foo:
+        - bar: baz/buz.md
+    - skctl: docs/skctl.md
+  - Contributing:
+    - Developer's Guide: docs/contributing.md
+    - API changes: docs/api_modifications.md