Material for Mkdocs
Write documentation in Markdown and instantly generate a fast, searchable, and fully customizable static site that works perfectly on all devices.
Focus on the content of your documentation without worrying about HTML, CSS, or JavaScript. Write everything in Markdown and instantly generate a professional, static site that adapts perfectly to any device. You maintain complete ownership of your sources and outputs, ensuring both integrity and security without relying on third-party platforms.\n\nEnjoy a rich set of features designed for technical writing:\n* Built-in search: Deliver blazing fast, offline-capable search running entirely in the browser.\n* Code annotations: Add rich text, images, and diagrams directly inside code blocks.\n* Social cards: Automatically generate beautiful preview images for social media sharing.\n* Extensive customization: Easily change colors, fonts, languages, and icons with minimal configuration.\n* Fast and lightweight: Achieve optimal search engine rankings with excellent performance.\n\nJoin thousands of developers using this open-source solution to build beautiful, functional documentation.
Directory Structure
docker-compose.yml
services:
mkdocs:
image: squidfunk/mkdocs-material
container_name: mkdocs-material
ports:
- "8000:8000"
volumes:
- ./docs:/docs
restart: unless-stopped.env
# No sensitive environment variables are required for the standard MkDocs Material setup.
# If you are using the Insiders edition or plugins requiring tokens (e.g. GH_TOKEN), define them here.
# GH_TOKEN=your_github_token
Similar to Material for Mkdocs