docs: Prepare for versioned documentation

kitten-science · Oct 3, 2024 · 351e676 · 351e676
1 parent 885613b
commit 351e676
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -9,3 +9,6 @@ insert_final_newline = true
 
 [*.md]
 indent_size = 4
+
+[Makefile]
+indent_style = tab
diff --git a/packages/documentation/.gitignore b/packages/documentation/.gitignore
@@ -0,0 +1,2 @@
+.venv/
+public/
diff --git a/packages/documentation/Makefile b/packages/documentation/Makefile
@@ -0,0 +1,9 @@
+.venv:
+	python3 -m venv .venv
+	. .venv/bin/activate; pip install mkdocs-material
+
+docs: .venv
+	. .venv/bin/activate; mkdocs build --config-file mkdocs.yml --site-dir public
+
+serve: .venv
+	. .venv/bin/activate; mkdocs serve --config-file mkdocs.yml
diff --git a/packages/documentation/package.json b/packages/documentation/package.json
@@ -7,9 +7,9 @@
   "license": "MIT",
   "author": "Oliver Salzburg <[email protected]>",
   "scripts": {
-    "docs:build": ".scripts/build.sh",
+    "docs:build": "make docs",
     "docs:nsd": "nsd --cwd=$INIT_CWD --docs-location=\"packages/documentation/docs/reference/Repository Scripts/\"",
-    "docs:serve": ".scripts/serve.sh"
+    "docs:serve": "make serve"
   },
   "devDependencies": {
     "node-scripts-docs": "1.0.4"