Skip to content

MkDocs & Material

Setup guides and feature references for MkDocs with the Material theme — from initial install through deployment, Obsidian integration, and the most useful built-in components.

Setup & Workflow

  • MkDocs Initial Setup — Step-by-step guide to setting up MkDocs with the Material theme on Windows, with GitHub Pages deployment.
  • Publish to GitHub Pages — Cheatsheet for the local update and GitHub Pages deployment workflow.
  • Obsidian Integration — How to use Obsidian as a writing front-end for an MkDocs site, with Git version control.

Feature Reference