squidfunk/mkdocs-material

基于 MkDocs 构建的强大文档框架

使用 Markdown 编写文档，并在几分钟内为您的开源或商业项目创建专业的静态站点 – 支持搜索、可自定义、 支持超过 60 种语言，并适配所有设备。

查看演示 – squidfunk.github.io/mkdocs-material.

 

Silver sponsors

 

Bronze sponsors

 

## 您所期望的一切 ### 只是 Markdown 专注于您的文档内容，并在几分钟内创建一个专业的静态站点。无需了解 HTML、CSS 或 JavaScript – 让 Material for MkDocs 为您完成繁重的工作。 ### 适用于所有设备 自信地提供您的文档 – Material for MkDocs 会自动调整以完美适应可用的屏幕空间，无论查看设备的类型或尺寸如何。桌面端。平板端。移动端。都非常出色。 ### 量身定制 使其成为您的专属 – 通过几行配置即可更改颜色、字体、语言、图标、Logo 等。Material for MkDocs 可以轻松扩展，并提供了许多选项来改变外观和行为。 ### 快速且轻量 不要让您的用户等待 – 使用具有出色性能的最快主题之一，以极小的占用空间获得令人难以置信的价值，从而获得最佳的搜索引擎排名和乐于回访的用户。 ### 保持所有权 拥有您文档的完整源码和输出，确保完整性和安全性 – 无需将您产品知识的核心托付给第三方平台。保留完全的控制权。 ### 开源 您与优秀的伙伴同行 – 选择一个使用最先进的开源技术构建的成熟且积极维护的解决方案，受到超过 50,000 名个人和组织的信赖。采用 MIT 许可。 ## 快速开始 Material for MkDocs 可以使用 `pip` 安装： ``` pip install mkdocs-material ``` 将以下行添加到 `mkdocs.yml` 中： ``` theme: name: material ``` 有关详细的安装说明、配置选项和演示，请访问 [squidfunk.github.io/mkdocs-material][Material for MkDocs] ## 值得信赖的 ... ### ... 行业领导者 [ArXiv](https://info.arxiv.org), [Atlassian](https://atlassian.github.io/data-center-helm-charts/), [AWS](https://aws.github.io/copilot-cli/), [Bloomberg](https://bloomberg.github.io/selekt/), [CERN](http://abpcomputing.web.cern.ch/), [Datadog](https://datadoghq.dev/integrations-core/), [Google](https://google.github.io/accompanist/), [Harvard](https://informatics.fas.harvard.edu/), [Hewlett Packard](https://hewlettpackard.github.io/squest/), [HSBC](https://hsbc.github.io/pyratings/), [ING](https://ing-bank.github.io/baker/), [Intel](https://open-amt-cloud-toolkit.github.io/docs/), [JetBrains](https://jetbrains.github.io/projector-client/mkdocs/), [LinkedIn](https://linkedin.github.io/school-of-sre/), [Microsoft](https://microsoft.github.io/code-with-engineering-playbook/), [Mozilla](https://mozillafoundation.github.io/engineering-handbook/), [Netflix](https://netflix.github.io/titus/), [OpenAI](https://openai.github.io/openai-agents-python/), [Red Hat](https://ansible.readthedocs.io/projects/lint/), [Roboflow](https://inference.roboflow.com/), [Salesforce](https://policy-sentry.readthedocs.io/), [SIEMENS](https://opensource.siemens.com/), [Slack](https://slackhq.github.io/circuit/), [Square](https://square.github.io/okhttp/), [Uber](https://uber-go.github.io/fx/), [Zalando](https://opensource.zalando.com/skipper/) ### ... 以及成功的开源项目 [Amp](https://amp.rs/docs/), [Apache Iceberg](https://iceberg.apache.org/), [Arduino](https://arduino.github.io/arduino-cli/), [Asahi Linux](https://asahilinux.org/docs/), [Auto-GPT](https://docs.agpt.co/), [AutoKeras](https://autokeras.com/), [BFE](https://www.bfe-networks.net/), [CentOS](https://docs.infra.centos.org/), [Crystal](https://crystal-lang.org/reference/), [eBPF](https://ebpf-go.dev/), [ejabberd](https://docs.ejabberd.im/), [Electron](https://www.electron.build/), [FastAPI](https://fastapi.tiangolo.com/), [FlatBuffers](https://flatbuffers.dev/), [{fmt}](https://fmt.dev/), [Freqtrade](https://www.freqtrade.io/en/stable/), [GoReleaser](https://goreleaser.com/), [GraphRAG](https://microsoft.github.io/graphrag/), [Headscale](https://headscale.net/), [HedgeDoc](https://docs.hedgedoc.org/), [Hummingbot](https://hummingbot.org/), [Knative](https://knative.dev/docs/), [Kubernetes](https://kops.sigs.k8s.io/), [kSQL](https://docs.ksqldb.io/), [LeakCanary](https://square.github.io/leakcanary/), [LlamaIndex](https://docs.llamaindex.ai/), [NetBox](https://netboxlabs.com/docs/netbox/en/stable/), [Nokogiri](https://nokogiri.org/), [OpenAI](https://openai.github.io/openai-agents-python/), [OpenFaaS](https://docs.openfaas.com/), [OpenSSL](https://docs.openssl.org/), [Orchard Core](https://docs.orchardcore.net/en/latest/), [Percona](https://docs.percona.com/percona-monitoring-and-management/), [Pi-Hole](https://docs.pi-hole.net/), [Polars](https://docs.pola.rs/), [Pydantic](https://pydantic-docs.helpmanual.io/), [PyPI](https://docs.pypi.org/), [Quivr](https://core.quivr.com/), [Renovate](https://docs.renovatebot.com/), [RetroPie](https://retropie.org.uk/docs/), [Ruff](https://docs.astral.sh/ruff/), [Supervision](https://supervision.roboflow.com/latest/), [Textual](https://textual.textualize.io/), [Traefik](https://docs.traefik.io/), [Trivy](https://aquasecurity.github.io/trivy/), [Typer](https://typer.tiangolo.com/), [tinygrad](https://docs.tinygrad.org/), [Ultralytics](https://docs.ultralytics.com/), [UV](https://docs.astral.sh/uv/), [Vapor](https://docs.vapor.codes/), [WebKit](https://docs.webkit.org/), [WTF](https://wtfutil.com/), [ZeroNet](https://zeronet.io/docs/) ## 许可证 **MIT 许可证** 版权所有 (c) 2016-2025 Martin Donath 特此免费授予任何获得本软件和相关文档文件（“软件”）副本的人不受限制地处置本软件的权利，包括不受限制地使用、复制、修改、合并、发布、分发、再授权和/或销售本软件副本的权利，以及再授权给配备了本软件的人员上述权利，前提是必须满足以下条件： 上述版权声明和本许可声明应包含在本软件的所有副本或重要部分中。 本软件按“原样”提供，不提供任何形式的担保，明示或暗示，包括但不限于适销性、特定用途的适用性和非侵权性的担保。在任何情况下，作者或版权持有人均不对任何索赔、损害或其他责任负责，无论是在合同诉讼、侵权行为还是其他方面，由本软件或本软件的使用或其他交易所引起的，或与之相关的。 SOFTWARE.

标签：DNS解析, Docker, IPv6支持, Markdown, Material Design, MkDocs, Python, Ruby, SEO, SOC Prime, SSG, 前端, 前端模板, 响应式设计, 多模态安全, 多语言, 安全防御评估, 建站, 开发工具, 开源项目, 技术文档, 搜索, 数据可视化, 文档托管, 文档框架, 无后门, 知识库, 请求拦截, 调试插件, 逆向工具, 防御加固, 静态网站生成器