Skip to content

MkDocs Setup#

This section contains all the guides you need to install and configure MkDocs Material for this documentation site.

Installation Guides#

Installation#

Complete installation guide for MkDocs Material theme and all required plugins. Start here if you're setting up the documentation for the first time.

Covers: - Installing MkDocs Material - Required plugins (minify, git-revision-date, glightbox) - System dependencies for image processing - Verification and troubleshooting

Image Processing#

Detailed guide for setting up image optimization and lightbox features.

Covers: - Material's optimize plugin (compression, WebP) - Glightbox plugin (click-to-zoom, galleries) - Platform-specific installation (Windows, macOS, Linux) - Testing and troubleshooting

Extensions Guide#

Reference guide for using all markdown extensions in your documentation.

Covers: - How to use each extension (Mermaid, admonitions, tabs, etc.) - Code examples - Best practices - Quick reference for daily writing

Quick Start#

  1. First time setup: Start with Installation
  2. Enable image features: Follow Image Processing
  3. Learn syntax: Reference Extensions Guide while writing

Need Help?#

If you encounter issues during setup: - Check the troubleshooting sections in each guide - Review the official Material documentation - Ensure all prerequisites are met (Python 3.8+, uv installed)

Related: - Resources - MkDocs commands reference - Progress - Documentation development status