From e248c07d4dc894a00d0be3b572fba80db700a91f Mon Sep 17 00:00:00 2001
From: omniscient <17525998+omnisci3nce@users.noreply.github.com>
Date: Sun, 12 May 2024 19:21:52 +1000
Subject: docker commands for mkdocs

---
 README.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index db00078..87da707 100644
--- a/README.md
+++ b/README.md
@@ -20,4 +20,11 @@ All third-party dependencies are licensed under their own license.
     * `xmake format`
     * Lint (no change) `find src/ -iname *.h -o -iname *.c | xargs clang-format --style=file --dry-run --Werror`
     * Format (edit in place) `find src/ \( -iname "*.h" -o -iname "*.c" \) | xargs clang-format -i --style=file`
-        * `clang-format` must be installed!
\ No newline at end of file
+        * `clang-format` must be installed!
+
+* Documentation
+    * serve mkdocs locally
+        * `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
+
+    * Build docs static site
+        * `docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build`
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2