freshcrate
Home > Frameworks > mkdocs-material

mkdocs-material

Documentation that simply works

Description

<p align="center"> <a href="https://squidfunk.github.io/mkdocs-material/"> <img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.svg" width="320" alt="Material for MkDocs"> </a> </p> <p align="center"> <strong> A powerful documentation framework on top of <a href="https://www.mkdocs.org/">MkDocs</a> </strong> </p> <p align="center"> <a href="https://github.com/squidfunk/mkdocs-material/actions"><img src="https://github.com/squidfunk/mkdocs-material/workflows/build/badge.svg" alt="Build" /></a> <a href="https://pypistats.org/packages/mkdocs-material"><img src="https://img.shields.io/pypi/dm/mkdocs-material.svg" alt="Downloads" /></a> <a href="https://pypi.org/project/mkdocs-material"><img src="https://img.shields.io/pypi/v/mkdocs-material.svg" alt="Python Package Index" /></a> <a href="https://hub.docker.com/r/squidfunk/mkdocs-material/"><img src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material" alt="Docker Pulls" /></a> </p> <p align="center"> Write your documentation in Markdown and create a professional static site for your Open Source or commercial project in minutes – searchable, customizable, more than 60 languages, for all devices. </p> <p align="center"> <a href="https://squidfunk.github.io/mkdocs-material/getting-started/"> <img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/screenshot.png" width="700" /> </a> </p> <p align="center"> <em> Check out the demo – <a href="https://squidfunk.github.io/mkdocs-material/" >squidfunk.github.io/mkdocs-material</a>. </em> </p> <h2></h2> <p id="premium-sponsors">&nbsp;</p> <p align="center"><strong>Silver sponsors</strong></p> <p align="center"> <a href="https://fastapi.tiangolo.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-fastapi.png" height="120" /></a> <a href="https://www.trendpop.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-trendpop.png" height="120" /></a> <a href="https://documentation.sailpoint.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sailpoint.png" height="120" /></a> <a href="https://futureplc.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-future.svg" width="332" height="120" /></a> <a href="https://opensource.siemens.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-siemens.png" height="120" /></a> </p> <p>&nbsp;</p> <p align="center"><strong>Bronze sponsors</strong></p> <p align="center"> <a href="https://cirrus-ci.org/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cirrus-ci.png" height="58" /></a> <a href="https://docs.baslerweb.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-basler.png" height="58" /></a> <a href="https://kx.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kx.png" height="58" /></a> <a href="https://orion-docs.prefect.io/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-prefect.png" height="58" /></a> <a href="https://www.zenoss.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-zenoss.png" height="58" /></a> <a href="https://docs.posit.co" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-posit.png" height="58" /></a> <a href="https://n8n.io" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-n8n.png" height="58" /></a> <a href="https://www.dogado.de" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-dogado.png" height="58" /></a> <a href="https://wwt.com" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-wwt.png" height="58" /></a> <a href="https://elastic.co" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-elastic.png" height="58" /></a> <a href="https://ipfabric.io/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material

Release History

VersionChangesUrgencyDate
9.7.6Imported from PyPI (9.7.6)Low4/21/2026
9.7.5> [!WARNING] > > __Material for MkDocs is in maintenance mode__ > > Going forward, the Material for MkDocs team focuses on [Zensical], a next-gen static site generator built from first principles. We will provide critical bug fixes and security updates for Material for MkDocs until November 2026. > > [Read the full announcement on our blog] [Zensical]: https://zensical.org [Read the full announcement on our blog]: https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/ Low3/10/2026
9.7.4> [!WARNING] > > __Material for MkDocs is in maintenance mode__ > > Going forward, the Material for MkDocs team focuses on [Zensical], a next-gen static site generator built from first principles. We will provide critical bug fixes and security updates for Material for MkDocs until November 2026. > > [Read the full announcement on our blog] [Zensical]: https://zensical.org [Read the full announcement on our blog]: https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/ Low3/3/2026
9.7.2> [!WARNING] > > __Material for MkDocs is in maintenance mode__ > > Going forward, the Material for MkDocs team focuses on [Zensical], a next-gen static site generator built from first principles. We will provide critical bug fixes and security updates for Material for MkDocs until November 2026. > > [Read the full announcement on our blog] [Zensical]: https://zensical.org [Read the full announcement on our blog]: https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/ Low2/18/2026
9.7.1> [!WARNING] > > __Material for MkDocs is in maintenance mode__ > > Going forward, the Material for MkDocs team focuses on [Zensical], a next-gen static site generator built from first principles. We will provide critical bug fixes and security updates for Material for MkDocs until November 2026. > > [Read the full announcement on our blog] [Zensical]: https://zensical.org [Read the full announcement on our blog]: https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/ Low12/18/2025
9.7.0> [!WARNING] > > __Material for MkDocs is now in maintenance mode__ > > This is the last release of Material for MkDocs that will receive new features. Going forward, the Material for MkDocs team focuses on [Zensical], a next-gen static site generator built from first principles. We will provide critical bug fixes and security updates for Material for MkDocs for 12 months at least. > > [Read the full announcement on our blog] This release includes all features that were previously exclLow11/11/2025
9.6.23- Updated Burmese translationLow11/1/2025
9.6.22- Updated Georgian translationLow10/15/2025
9.6.21- Updated Serbian translations - Fixed #8458: Temporary pin of click dependencyLow9/30/2025
9.6.20- Fixed #8446: Deprecation warning as of Python 3.14 in Emoji extension - Fixed #8440: `&` character not escaped in search highlighting - Fixed #8439: FontAwesome icons color not set in social cards (regression)Low9/15/2025
9.6.19- Added support for Python 3.14 - Updated Bahasa Malaysia translationsLow9/7/2025
9.6.18- Updated Azerbaijani translations - Fixed last compat issues with [minijinja], now 100% compatible [minijinja]: https://github.com/mitsuhiko/minijinjaLow8/22/2025
9.6.17- Fixed #8396: Videos do not autoplay when inside a content tab - Fixed #8394: Stroke width not effective in Mermaid.js diagrams - Fixed disappearing version selector when hiding page titleLow8/15/2025
9.6.16- Fixed #8349: Info plugin doesn't correctly detect virtualenv in some cases - Fixed #8334: Find-in-page detects matches in hidden search result listLow7/26/2025
9.6.15- Updated Mongolian translations - Improved semantic markup of "edit this page" button - Improved info plugin virtual environment resolution - Fixed #8291: Large font size setting throws of breakpoints in JavaScriptLow7/1/2025
9.6.14- Fixed #8215: Social plugin crashes when CairoSVG is updated to 2.8Low5/13/2025
9.6.13* Fixed #8204: Annotations showing list markers in print view * Fixed #8153: Improve style of cardinality symbols in Mermaid.js ER diagramsLow5/10/2025
9.6.12- Fixed #8158: Flip footnote back reference icon for right-to-left languagesLow4/17/2025
9.6.11- Updated Docker image to latest Alpine Linux - Bump required Jinja version to 3.1 - Fixed #8133: Jinja filter `items` not available (9.6.10 regression) - Fixed #8128: Search plugin not entirely disabled via enabled settingLow4/1/2025
9.6.10This version is a pure refactoring release, and does not contain new features or bug fixes. It strives to improve the compatibility of our templates with alternative Jinja-like template engines that we're currently exploring, including [minijinja]. Additionally, it replaces several instances of Python function invocations with idiomatic use of template filters. All instances where variables have been mutated inside templates have been replaced. Most changes have been made in partials, and onlLow3/30/2025
9.6.9- Updated Serbo-Croatian translations - Fixed #8086: Custom SVG icons containing hashes break rendering - Fixed #8067: Drawer has gap on right side in Firefox on some OSsLow3/17/2025
9.6.8- Added Welsh translations - Fixed #8076: Privacy plugin crashes if HTTP download failsLow3/13/2025
9.6.7- Fixed #8056: Error in backrefs implementation (9.6.6 regression) - Fixed #8054: Unescaped quotes in ARIA labels of table of contentsLow3/3/2025
9.6.6- Fixed #8040: Privacy plugin not replacing exteral assets (9.6.5 regression) - Fixed #8031: Replace unmaintained `regex` package in search pluginLow3/1/2025
9.6.5- Fixed #8016: Tags listing not showing when when file name has spaces - Fixed #8012: Privacy plugin crashes if HTTP download failsLow2/20/2025
9.6.4- Fixed #7985: Blog content sometimes not stretching to full width - Fixed #7978: Navigation rendering bug in Safari 18.3Low2/12/2025
9.6.3- Fixed rendering of arrow heads in Mermaid.js class diagrams - Fixed #7960: Tags plugin crashes on numeric metadata titlesLow2/7/2025
9.6.2- Fixed #7955: Excessively long words don't break on narrow screens - Fixed #7947: Scope setting interferes with outdated version bannerLow2/3/2025
9.6.1- Fixed #7943: Tags plugin crashing due to merge errorLow1/31/2025
9.6.0- Added meta plugin - Rewrite of the tags plugin - Added support for allow lists in tags plugin - Added support for and custom sorting in tags plugin - Added support for related links in blog plugin - Added support for custom index pages in blog plugin - Added support for navigation subtitles - Fixed #7924: Anchors might require two clicks when using instant navigationLow1/31/2025
9.5.50- Fixed #7913: Social plugin renders attribute lists in page titleLow1/18/2025
9.5.49- Adjusted title color in dark mode for all supported Mermaid.js diagrams - Fixed #7803: Privacy plugin crashes on generated files - Fixed #7781: Mermaid.js flow chart title not visible in dark modeLow12/16/2024
9.5.48- Fixed #7774: Disabling social cards doesn't workLow12/8/2024
9.5.47- Fixed #7750: Numeric tags break search - Fixed #7748: Blog plugin breaks when using future drafts (9.5.45 regression) Thanks go to @perpil for their contributionsLow12/1/2024
9.5.46- Added support for removing `preload` hints in privacy plugin - Fixed #7734: Code blocks in h5 headlines are uppercased - Fixed #7725: Blog plugin crashing on missing timezone (9.5.45 regression) Thanks go to @nejch and @perpil for their contributionsLow11/25/2024
9.5.45- Reduced size of Docker image through multi-stage build - Fixed #7708: Blog plugin crashing on YAML dates with timezones Thanks go to @FrancoisCapon and @perpil for their contributionsLow11/20/2024
9.5.44- Fixed #7672: Font CSS 404's when using privacy plugin (9.5.43 regression) Thanks go to @nejch for their contributions.Low11/5/2024
9.5.43- Added support for external images in SVGs in privacy plugin - Fixed #7651: Privacy plugin doesn't handle quoted URLs in CSS Thanks go to @nejch for their contributionsLow10/31/2024
9.5.42- Fixed #7625: Invalid encoding of boolean attributes in privacy plugin - Fixed #7624: Crash when disabling privacy plugin (9.5.41 regression)Low10/20/2024
9.5.41- Fixed #7619: Improved tooltip on logo disappears after instant navigation - Fixed #7616: Race condition in built-in privacy plugin when inlining assets - Fixed #7615: Comments and "Was this page helpful?" visible when printingLow10/15/2024
9.5.40- Updated Latvian translations - Fixed #7597: Social cards not using site name on home page Thanks go to @pekkaklarck and @klejejs for their contributionsLow10/10/2024
9.5.39- Fixed #7226: not staying on page when using mike's canonical versioning Thanks go to @ilyagr for their contributionsLow9/29/2024
9.5.38- Added Albanian translations Thanks go to @gerardkraja for their contributionsLow9/26/2024
9.5.37- Added 4th and 5th level ordered list styles - Fixed #7548: Tags have no spacing in searchLow9/25/2024
9.5.36- Fixed #7544: Social cards incorrectly rendering HTML entities - Fixed #7542: Improved support for setting custom list stylesLow9/21/2024
9.5.35- Fixed #7498: Search not showing for Vietnamese languageLow9/18/2024
9.5.34- Updated Mermaid.js to version 11 (latest) Thanks go to @manselmi for their contributionsLow8/31/2024
9.5.33- Fixed #7453: Incorrect position of tooltip when sorting tableLow8/23/2024
9.5.32- Fixed RXSS vulnerability via deep link in search results - Added support for fetching latest release from GitLab Thanks go to @joaopalmeiro for their contributionsLow8/19/2024
9.5.31- Fixed #7405: DockerHub missing images > 9.5.27 due to change in Alpine/APKLow8/2/2024

Dependencies & License Audit

Loading dependencies...

Similar Packages

drf-yasgAutomated generation of real Swagger/OpenAPI 2.0 schemas from Django Rest Framework code.1.21.15
hatch-fancy-pypi-readmeFancy PyPI READMEs with Hatch25.1.0
pre-commitA framework for managing and maintaining multi-language pre-commit hooks.v4.6.0
azure-core-tracing-opentelemetryMicrosoft Azure Azure Core OpenTelemetry plugin Library for Pythonazure-template_0.1.0b6187637
spdx-toolsSPDX parser and tools.0.8.5