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…

这是什么?Material for MkDocs 是一个基于 MkDocs 构建的文档主题和框架,可以把 Markdown 文件转换成专业、可搜索的静态文档网站。
它是 MkDocs 上的主题,还是独立的静态站点生成器?它是扩展 MkDocs 的主题和框架,而不是它的替代品。你仍然用 Markdown 编写内容,由 MkDocs 生成网站,Material 只提供外观、交互效果和插件。
我该如何让它运行起来?用 pip 安装,然后在 mkdocs.yml 中添加几行配置,把它设为主题。
我需要先安装 Python 吗?需要。它是通过 pip 分发的 Python 包,因此必须有可用的 Python/pip 环境。
使用它需要懂 HTML、CSS 或 JavaScript 吗?不需要。这个项目的设计让你只需编写 Markdown 并配置 YAML,HTML、CSS 和 JS 的渲染由它自动完成。
谁已经在生产环境中使用它?它受到大型公司和开源项目的信赖,包括 AWS、Google、Microsoft、Kubernetes、FastAPI 和 Pydantic。
我的文档网站在手机和平板上也能正常使用吗?可以,主题会自动将布局适配到桌面、平板和手机屏幕。
我的文档会托管在第三方平台上吗?不会。你完全拥有源文件和生成的输出文件,因此内容不依赖外部托管服务。
我可以自定义网站的外观吗?可以,通过几行配置就能更改颜色、字体、语言、图标和徽标,而且主题设计上易于扩展。
文档支持多种语言吗?支持,网站内容和搜索功能支持 60 多种语言。
内置搜索功能吗?内置。项目捆绑了基于客户端的搜索,使用 lunr 和 lunr-languages,因此无需服务器,文档开箱即可搜索。
为什么要选它而不是普通的 MkDocs 主题?它针对速度和低资源占用做了优化,同时提供丰富的自定义选项(颜色、字体、图标),并且持续维护,已被 50,000 多名个人和组织使用,功能成熟,经过了实战检验。
Creator
squidfunk
Size
144.1 MB
Stars
27.6K
Age
10y
Commits · 90 Days