Repository files navigation

A powerful documentation framework on top ofMkDocs

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.

Check out the demo –squidfunk.github.io/mkdocs-material.

Silver sponsors

Bronze sponsors

Focus on the content of your documentation and create a professional static sitein minutes. No need to know HTML, CSS or JavaScript – let Material for MkDocs dothe heavy lifting for you.

Serve your documentation with confidence – Material for MkDocs automaticallyadapts to perfectly fit the available screen estate, no matter the type or sizeof the viewing device. Desktop. Tablet. Mobile. All great.

Make it yours – change the colors, fonts, language, icons, logo, and more witha few lines of configuration. Material for MkDocs can be easily extended andprovides many options to alter appearance and behavior.

Don't let your users wait – get incredible value with a small footprint by usingone of the fastest themes available with excellent performance, yielding optimalsearch engine rankings and happy users that return.

Own your documentation's complete sources and outputs, guaranteeing bothintegrity and security – no need to entrust the backbone of your productknowledge to third-party platforms. Retain full control.

You're in good company – choose a mature and actively maintained solution builtwith state-of-the-art Open Source technologies, trusted by more than 50,000individuals and organizations. Licensed under MIT.

Material for MkDocs can be installed withpip:

pip install mkdocs-material

Add the following lines tomkdocs.yml:

theme:name:material

For detailed installation instructions, configuration options, and a demo, visitsquidfunk.github.io/mkdocs-material

ArXiv,Atlassian,AWS,Bloomberg,CERN,Datadog,Google,Harvard,Hewlett Packard,HSBC,ING,Intel,JetBrains,LinkedIn,Microsoft,Mozilla,Netflix,OpenAI,Red Hat,Roboflow,Salesforce,SIEMENS,Slack,Square,Uber,Zalando

Amp,Apache Iceberg,Arduino,Asahi Linux,Auto-GPT,AutoKeras,BFE,CentOS,Crystal,eBPF,ejabberd,Electron,FastAPI,FlatBuffers,{fmt},Freqtrade,GoReleaser,GraphRAG,Headscale,HedgeDoc,Hummingbot,Knative,Kubernetes,kSQL,LeakCanary,LlamaIndex,NetBox,Nokogiri,OpenAI,OpenFaaS,OpenSSL,Orchard Core,Percona,Pi-Hole,Polars,Pydantic,PyPI,Quivr,Renovate,RetroPie,Ruff,Supervision,Textual,Traefik,Trivy,Typer,tinygrad,Ultralytics,UV,Vapor,WebKit,WTF,ZeroNet

MIT License

Copyright (c) 2016-2025 Martin Donath

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), todeal in the Software without restriction, including without limitation therights to use, copy, modify, merge, publish, distribute, sublicense, and/orsell copies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISINGFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGSIN THE SOFTWARE.