sig9/mkdocs-material repository overview

⁠Docker image of Material for MkDoc

• Zensical Official
  • Zensical⁠
  • Zensical Documentation⁠
  • Backlog⁠
  • GitHub⁠
  • PyPi⁠ (History⁠)
• Unofficial
  • DockerHub
    • sig9/zensical⁠
  • GitHub
    • Docker image of Zensical⁠
    • Template for Zensical⁠

⁠How to Use

docker run --rm -v ${PWD}:/docs sig9/mkdocs-material:9.7.7 mkdocs build --clean

⁠DockerHub Supported tags

• 9.7.7⁠ (2026/06/18)
• 9.7.6⁠ (2026/03/20)
• 9.7.1⁠ (2025/12/18)
• 9.7.0⁠ (2025/11/11)
• 9.6.23⁠ (2025/11/02)
• 9.6.22⁠ (2025/10/15)
• 9.6.21⁠ (2025/10/01)
• 9.6.20⁠ (2025/09/15)
• 9.6.19⁠ (2025/09/08)
• 9.6.16⁠ (2025/07/27)

⁠Example CI/CD Configuration for GitLab Pages (.gitlab-ci.yml)

stages:
  - build

build-job:
  stage: build
  script:
    - docker run --user $(id -u):$(id -g) --rm -v ${PWD}:/docs sig9/mkdocs-material:9.7.7 mkdocs build --clean
    - rm -rf /var/www/html/*
    - cp -R site/* /var/www/html/

⁠How to Build a Docker Container Image

⁠Latest

docker buildx build \
    --platform linux/amd64,linux/arm64 \
    --output=type=registry \
    --tag sig9/mkdocs-material:latest \
    versions/9.7.7/

⁠9.7.7

docker buildx build \
    --platform linux/amd64,linux/arm64 \
    --output=type=registry \
    --tag sig9/mkdocs-material:9.7.7 \
    versions/9.7.7/

⁠Installed extensions

⁠Themes

• Material Design theme⁠ usings Google’s Material Design guidelines.

⁠Plugins

• autorefs⁠ automatically link across pages.
• markdown⁠ is Python implementation of John Gruber's Markdown.
• Material Extensions⁠ extension resources for MkDocs for Material
• Minify⁠ to minify HTML and/or JS files prior to being written to disk.
• Mkdocs with Confluence⁠ Plugin for uploading markdown documentation to Confluence via Confluence REST API
• mkdocs_macros_plugin⁠ transforms the markdown pages into jinja2 templates that use variables, calls to macros and custom filters.
• mkdocs_puml⁠ is a fast and simple package that brings plantuml diagrams to MkDocs documentation.
• mkdocs_pymdownx_material_extras⁠
• mkdocs-abs-rel-plugin⁠
• mkdocs-add-number-plugin⁠ plugin to automatically number the headings (h1-h6) in each markdown page and the nav.
• mkdocs-autolinks-plugin⁠ simplifies relative linking between documents.
• mkdocs-awesome-pages-plugin⁠ allows you to customize how your pages show up the navigation of your MkDocs without having to configure the full structure in your mkdocs.yml.
• mkdocs-breadcrumbs-plugin⁠ is Mkdocs location-based breadcrumbs navigation.
• mkdocs-build-plantuml-plugin⁠ automates the generation of PlantUML image files when using mkdocs serve.
• mkdocs-categories-plugin⁠ allows for multiple categories per page and will generate a category index page
• mkdocs-drawio⁠ enables you to embed interactive drawio diagrams in your documentation.
• mkdocs-enumerate-headings-plugin⁠ will enumerate the headings (h1-h6) across site pages.
• mkdocs-exclude-unused-files⁠ for excluding files from being included in the mkdocs output if they are not referenced on other pages.
• mkdocs-exclude⁠ allows you to exclude files from your input using unix-style wildcards (globs) or regular expressions (regexes).
• mkdocs-gallery⁠
• mkdocs-gemini-chatbot⁠ that adds a conversational chatbot to your documentation site, powered by Google's Gemini models. The chatbot uses the entire content of your documentation, including auto-generated API references, to provide intelligent, context-aware answers with precise, clickable links to the relevant sections.
• mkdocs-gen-files⁠ programmatically generates documentation pages during the build.
• mkdocs-git-authors-plugin⁠
• mkdocs-git-committers-plugin-2⁠
• mkdocs-git-revision-date-localized-plugin⁠
• mkdocs-img2fig-plugin⁠ converts <img> to <figure>.
• mkdocs-kroki-plugin⁠
• mkdocs-link-marker⁠ for marking external or mail links in your documentation.
• mkdocs-literate-nav⁠ specifies the navigation in Markdown instead of YAML.
• mkdocs-markdownextradata-plugin⁠ injects the mkdocs.yml extra variables into the markdown template.
• mkdocs-merge⁠ allows you to merge the source of multiple MkDocs sites into a single one converting each of the specified sites to a sub-site of the master site.
• mkdocs-monorepo-plugin⁠ Build multiple documentation in a single Mkdocs. Designed for large codebases.
• mkdocs-multirepo-plugin⁠ Build documentation in multiple repos into one site.
• mkdocs-nav-weight⁠ enables to organize navigation in a more markdownic way
• mkdocs-no-sitemap-plugin⁠ disables the generation of a sitemap in Mkdocs sites.
• mkdocs-print-site-plugin⁠ adds a page to your site combining all pages, allowing your site visitors to File > Print > Save as PDF the entire site.
• mkdocs-publish-control⁠ that allows you to control page visibility based on metadata. Perfect for managing draft content or private documentation within your MkDocs site.
• mkdocs-publisher⁠
• mkdocs-redirects⁠ to create page redirects (e.g. for moved/renamed pages).
• mkdocs-ruby-plugin⁠ to add pinyin/furigana to Chinese/Japanese Kanji text.
• mkdocs-safe-text-plugin⁠ for safe text editing with MKDocs.
• mkdocs-same-dir⁠ allows placing mkdocs.yml in the same directory as documentation.
• mkdocs-simple-hooks⁠ to define your own hooks for mkdocs, without having to create a new package.
• mkdocs-simple-plugin⁠ enables you to build a documentation site from markdown interspersed within your repository using mkdocs.
• mkdocs-swagger-ui-tag⁠
• mkdocs-table-of-figures⁠ that automatically generates figures with a figcaption, and lists all figures across your documentation into a Table of Figures that can be inserted into your Markdown pages.
• mkdocs-toggle-sidebar-plugin⁠ allows you to toggle the left (navigation) and right (table of contents) sidebars on a couple of MkDocs themes such as Material for MkDocs.
• mkdocs-video⁠ allows you to embed videos on the documentation pages using a simple Markdown syntax.
• Mkdocstrings⁠ automatic documentation from sources.
• Neoterot plugins⁠

⁠Markdown extension

• Breakless Lists Markdown Extension⁠ Use lists without requiring a line break above them.
• Customblocks⁠ settles a common markup for parametrizable and nestable components.
• Include⁠ allows the inclusion of the contents of other Markdown documents.
• Mdx Truly Sane Lists⁠ that makes lists truly sane. Features custom indents for nested lists and fix for messy linebreaks and paragraphs between lists.
• Pygments⁠ is a generic syntax highlighter.
• PyMdown Extensions⁠ is a collection of extensions for Python Markdown.

⁠References

• Official
  • MkDocs⁠
    • GitHub⁠
    • PyPi⁠ (History⁠)
  • Material for MkDocs⁠
    • GitHub⁠
    • PyPi⁠ (History⁠)
• Unofficial
  • DockerHub
    • sig9/mkdocs-material⁠
  • GitHub
    • Docker image of Material for MkDoc⁠