mkdocs-material

<p align="center"> <a href="https://squidfunk.github.io/mkdocs-material/"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/66507e5e-d930-4bb7-b584-b49e5d519346.svg" width="320" alt="Material for MkDocs"> </a> </p> <p align="center"> <strong> 基于<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?branch=master" alt="构建" /></a> <a href="https://pypistats.org/packages/mkdocs-material"><img src="https://img.shields.io/pypi/dm/mkdocs-material.svg" alt="下载量" /></a> <a href="https://pypi.org/project/mkdocs-material"><img src="https://img.shields.io/pypi/v/mkdocs-material.svg" alt="Python包索引" /></a> <a href="https://hub.docker.com/r/squidfunk/mkdocs-material/"><img src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material" alt="Docker拉取次数" /></a> <a href="https://github.com/sponsors/squidfunk"><img src="https://img.shields.io/github/sponsors/squidfunk" alt="赞助者" /></a> </p> <p align="center"> 用Markdown编写文档，几分钟内为您的开源或商业项目创建专业的静态网站 - 可搜索、可定制、支持60多种语言，适用于所有设备。 </p> <p align="center"> <a href="https://squidfunk.github.io/mkdocs-material/getting-started/"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/2e605133-0e23-4ddb-9c27-6d4e372a844e.png" width="700" /> </a> </p> <p align="center"> <em> 查看演示 - <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>白银赞助商</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" height="120" /></a> </p> <p>&nbsp;</p> <p align="center"><strong>铜牌赞助商</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://coda.io" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-coda.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/master/.github/assets/sponsors/sponsor-ip-fabric.png" height="58" /></a> <a href="https://www.apex.ai/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-apex-ai.png" height="58" /></a> <a href="https://jitterbit.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-jitterbit.png" height="58" /></a> <a href="https://sparkfun.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sparkfun.png" height="58" /></a> <a href="https://eccenca.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-eccenca.png" height="58" /></a> <a href="https://neptune.ai/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-neptune-ai.png" height="58" /></a> <!-- <a href="https://cash.app/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cashapp.png" height="58" /></a> --> <a href="https://rackn.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-rackn.png" height="58" /></a> <a href="https://civicactions.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-civic-actions.png" height="58" /></a> <a href="https://bitcrowd.net/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-bitcrowd.png" height="58" /></a> <a href="https://getscreen.me/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-getscreenme.png" height="58" /></a> <a href="https://botcity.dev/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-botcity.png" height="58" /></a> <a href="https://www.springernature.com/gp" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sn-technology.png" height="58" /></a> <a href="https://kolena.io/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kolena.png" height="58" /></a> <a href="https://www.evergiving.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-evergiving.png" height="58" /></a> <a href="https://koor.tech/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-koor.png" height="58" /></a> <a href="https://astral.sh/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-astral.png" height="58" /></a> <a href="https://oikolab.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-oikolab.png" height="58" /></a> <a href="https://www.buhlergroup.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-buhler.png" height="58" /></a> <a href="https://3dr.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-3dr.png" height="58" /></a> <a href="https://spotware.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-spotware.png" height="58" /></a> <a href="https://milfordasset.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-milford.png" height="58" /></a> <a href="https://www.lechler.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-lechler.png" height="58" /></a> <a href="https://invers.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-invers.png" height="58" /></a> <a href="https://maxar.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-maxar.png" height="58" /></a> <a href="https://www.equipmentshare.com/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-equipmentshare.png" height="58" /></a> <a href="https://hummingbot.org/" target=_blank><img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-hummingbot.png" height="58" /></a> </p> <p>&nbsp;</p>

你所期望的一切

只是 Markdown

专注于文档内容，几分钟内即可创建专业的静态网站。无需了解 HTML、CSS 或 JavaScript —— 让 Material for MkDocs 为你完成繁重的工作。

适用于所有设备

自信地提供你的文档 —— Material for MkDocs 会自动适应以完美fit可用的屏幕空间，无论查看设备的类型或大小如何。台式机、平板电脑、手机，都很棒。

量身定制

让它成为你的 —— 只需几行配置即可更改颜色、字体、语言、图标、logo 等。Material for MkDocs 可以轻松扩展，并提供许多选项来改变外观和行为。

快速轻量

不要让用户等待 —— 使用一个可用的最快主题之一，获得令人难以置信的价值，占用空间小，性能出色，为搜索引擎排名和快乐的回访用户提供最佳体验。

为每个人而建

将可访问性作为优先事项 —— 用户可以使用触摸设备、键盘和屏幕阅读器浏览你的文档。语义标记确保你的文档适用于每个人。

开源

信任 20,000+ 用户 —— 选择一个成熟且积极维护的解决方案，使用最先进的开源技术构建。保持对内容的所有权，无需担心供应商锁定。根据 MIT 许可。

快速开始

Material for MkDocs 可以通过 pip 安装：

pip install mkdocs-material

在 mkdocs.yml 中添加以下几行：

theme:
  name: material

有关详细的安装说明、配置选项和演示，请访问 squidfunk.github.io/mkdocs-material

受信赖于...

...行业领袖

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

...以及成功的开源项目

Arduino, Auto-GPT, AutoKeras, BFE, CentOS, Crystal, Electron, FastAPI, GoReleaser, Knative, Kubernetes, kSQL, Nokogiri, OpenFaaS, Percona, Pi-Hole, Pydantic, PyPI, Renovate, Traefik, Trivy, Vapor, ZeroNet, WebKit, WTF

许可证

MIT许可证

版权所有 (c) 2016-2024 Martin Donath

特此免费授予任何获得本软件副本和相关文档文件（"软件"）的人不受限制地处理本软件的权利，包括但不限于使用、复制、修改、合并、出版、分发、再许可和/或销售软件副本的权利，以及允许向其提供软件的人这样做，但须符合以下条件：

上述版权声明和本许可声明应包含在本软件的所有副本或重要部分中。

本软件按"原样"提供，不附带任何明示或暗示的担保，包括但不限于对适销性、特定用途适用性和非侵权性的担保。在任何情况下，作者或版权持有人均不对任何索赔、损害或其他责任负责，无论是在合同诉讼、侵权行为还是其他方面，产生于、源于或与本软件有关，或与本软件的使用或其他交易有关。