Skip to content

Configuration and Local development

Configuration

Project documentation with Markdown

Configuration settings

mkdocs.yml

Project settings are configured by default using a YAML configuration file in the project directory named mkdocs.yml
https://www.mkdocs.org/user-guide/configuration/

Local development

Start mkdocs server on non-default port

start.sh

#!/bin/bash

git submodule update --init --recursive; 
# git submodule foreach --recursive git reset --hard origin/main; 

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 &

Stop mkdocs server

pkill -f "mkdocs serve"