git » sdk » commit a852325

Add mkdocs config

author Stephen Paul Weber
2025-09-29 21:05:04 UTC
committer Stephen Paul Weber
2025-09-29 21:05:04 UTC
parent 7314f7a2808c51f07a12a1ac4f63ef588814755b

Add mkdocs config

Makefile +1 -0
mkdocs.yml +28 -0

diff --git a/Makefile b/Makefile
index 9b2ef82..abb911b 100644
--- a/Makefile
+++ b/Makefile
@@ -74,6 +74,7 @@ site/haxe/index.html:
 	haxelib run dox --toplevel-package borogove -i haxedoc.xml -o site/haxe/
 
 doc: site/haxe/index.html
+	mkdocs build
 
 clean:
 	rm -f npm/browser.js npm/index.js npm/borogove.js npm/borogove-enums.js
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..b13d04c
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,28 @@
+site_name: "Borogove SDK"
+
+theme:
+  name: readthedocs
+
+plugins:
+  - search
+  - mkdoxy:
+      projects:
+        c:
+          src-dirs: ./cpp/
+          full-doc: true
+          doxy-cfg:
+            PREDEFINED: API_PREFIX MKDOCS
+            OPTIMIZE_FOR_C: true
+            JAVADOC_BANNER: true
+            JAVADOC_AUTOBRIEF: true
+            FILE_PATTERNS: "borogove.h"
+            RECURSIVE: false
+
+markdown_extensions:
+  - markdown.extensions.md_in_html
+
+nav:
+  - Home: index.md
+  - API:
+    - C: c/borogove_8h.md
+    - JavaScript: js/borogove-sdk.md