This is a MkDocs site that hosts my second brain as a GitHub Pages site. It uses the mkdocs-terminal theme.
This project uses git submodules. Clone the site including submodules, then change directories into the project root.
git clone --recurse-submodules https://github.com/kraker/notes.git
cd notes
Python virtual environments are recommended. Create a venv and source it.
python3 -m venv .env
source .env/bin/activate
Install Python development environment dependencies.
python3 -m pip install -r requirements-dev.txt
Serve the site locally.
mkdocs serve
Update submodules.
git submodule update --remote
Deploy to GitHub Pages.
mkdocs gh-deploy
MIT
Written by Alex Kraker (@kraker)