Skip to content

mkdocs-material

Set up python environment

python -m venv .venv
source .venv/bin/activate

Install mkdocs-material

# install insiders
pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
pip install mkdocs-awesome-pages-plugin

Dev server

# host locally for testing
mkdocs serve

Build and deploy

Build for deployment

# build for deployment
mkdocs build

Deploy to Cloudflare

# deploy to cloudflare
CLOUDFLARE_ACCOUNT_ID=${CF_TOKEN} npx wrangler pages publish ./site --project-name boozedog

References

Material for MkDocs

GitHub - squidfunk/mkdocs-material: Documentation that simply works

Installation - Material for MkDocs

Python - NixOS Wiki

Getting started with Insiders - Material for MkDocs

Code formatting test

Here is some shell script

# Here is some stuff
git commit -a

Here is some YAML

plugins:
  - awesome-pages
  - blog
# - optimize

Embedded image

Here is Tex Johnson doing a barrel roll in an airliner Barrel roll