MkDocs
Configuration
Git Submodules
Set submodule to track the main branch instead of a specific commit. Required for recursive checkout of submodules.
git submodule add --force --depth 1 https://github.com/jdedev/tophomelabwork.git docs/projects/tophomelabwork
cd docs/projects/tophomelabwork
git checkout main
git branch --set-upstream-to=origin/main
git pull
Local development
Start MkDocs server on non-default port
#!/bin/bash
git pull --recurse-submodules
git submodule update --remote --merge
pip install mkdocs mkdocs-material; pip install mkdocs-glightbox; pip install mkdocs-awesome-nav
pkill -f "mkdocs serve -a 0.0.0.0:8081"
nohup mkdocs serve -a 0.0.0.0:8081 > mkdocs.log 2>&1 &