mkdocs-material README

The project's README from github.com/squidfunk/mkdocs-material. As one markdown file: README.md.

Material for MkDocs

A powerful documentation framework on top of MkDocs

Build Downloads Python Package Index Docker Pulls

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

 

Everything you would expect

It's just Markdown

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

Works on all devices

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

Made to measure

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

Fast and lightweight

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

Maintain ownership

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

Open Source

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

Quick start

Material for MkDocs can be installed with pip:

pip install mkdocs-material

Add the following lines to mkdocs.yml:

theme:
  name: material

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

Trusted by ...

... industry leaders

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

... and successful Open Source projects

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

License

MIT License

Copyright (c) 2016-2025 Martin Donath

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

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

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

mkdocs-material (squidfunk/mkdocs-material)

Searching Database…

27.6K ·GitHub
Mkdocs-material
What is this?Material for MkDocs is a documentation theme and framework built on top of MkDocs that turns Markdown files into a professional, searchable static documentation site.
Is this a theme on top of MkDocs or a standalone static site generator?It's a theme/framework that extends MkDocs, not a replacement for it — you still write content in Markdown and MkDocs builds the site, Material just supplies the look, behavior and plugins.
How do I get it running?Install it with pip, then add a few lines to your mkdocs.yml to set it as the theme.
Do I need Python installed first?Yes, it's a Python package distributed via pip, so a working Python/pip environment is required.
Do I need to know HTML, CSS or JavaScript to use it?No — the project is designed so you only write Markdown and configure YAML; it handles the HTML/CSS/JS rendering for you.
Who already uses this in production?It's trusted by major companies and open-source projects alike, including AWS, Google, Microsoft, Kubernetes, FastAPI and Pydantic.
Does my documentation site work on mobile and tablets too?Yes, the theme automatically adapts its layout to desktop, tablet, and mobile screens.
Is my documentation hosted on a third-party platform?No — you keep full ownership of the source files and the generated output, so you aren't relying on an external hosting service for your content.
Can I customize the look of my site?Yes, you can change colors, fonts, language, icons and logo through a few configuration lines, and the theme is built to be easily extended.
Does it support multiple languages for my docs?Yes, it supports more than 60 languages for site content and search.
Is search built in?Yes, the project bundles client-side search via lunr and lunr-languages, so documentation is searchable out of the box without a server.
Why choose this over a plain MkDocs theme?It's optimized for speed and small footprint while offering extensive customization (colors, fonts, icons) and is actively maintained and used by 50,000+ individuals and organizations, giving it a mature, battle-tested feature set.
What are similar projects?django-cms, zola, mkdocs, fumadocs, jekyll-theme-chirpy, quarkdown, docz, nextra
Which topics is it in?content-management, internationalization, documentation-tool, plugins, static-site-generator, material-design, pwa, theme, search, i18n, documentation, markdown
Creator
squidfunk
Size
144 MB
Stars
27.6K
Updated
CommitOct 14Release9.7.7Jul 17
Age
10y
Commits · 90 Days