mkdocs-material

mkdocs-material

基于MkDocs的文档框架 轻松创建专业静态网站

mkdocs-material是基于MkDocs的文档框架,支持使用Markdown快速创建专业静态网站。该框架支持60多种语言,提供搜索功能,可自定义,适配多种设备。具有快速、轻量、易用等特点,适用于开源和商业项目。无需掌握HTML、CSS或JavaScript,即可轻松构建高质量文档网站。

MkDocs文档框架静态网站生成器Markdown开源项目Github
<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

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

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

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

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具,支持从文本描述、单张图片或多视角图片生成 3D 模型,具备快速形状生成能力,可生成带纹理的高质量 3D 模型,适用于多个领域,为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目,涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作,如创建文件和目录、设置布局等,同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景,能够提高系统的性能和可靠性,是分布式存储领域的优质解决方案。

TRELLIS

TRELLIS

用于可扩展和多功能 3D 生成的结构化 3D 潜在表示

TRELLIS 是一个专注于 3D 生成的项目,它利用结构化 3D 潜在表示技术,实现了可扩展且多功能的 3D 生成。项目提供了多种 3D 生成的方法和工具,包括文本到 3D、图像到 3D 等,并且支持多种输出格式,如 3D 高斯、辐射场和网格等。通过 TRELLIS,用户可以根据文本描述或图像输入快速生成高质量的 3D 资产,适用于游戏开发、动画制作、虚拟现实等多个领域。

ai-agents-for-beginners

ai-agents-for-beginners

10 节课教你开启构建 AI 代理所需的一切知识

AI Agents for Beginners 是一个专为初学者打造的课程项目,提供 10 节课程,涵盖构建 AI 代理的必备知识,支持多种语言,包含规划设计、工具使用、多代理等丰富内容,助您快速入门 AI 代理领域。

AEE

AEE

AI Excel全自动制表工具

AEE 在线 AI 全自动 Excel 编辑器,提供智能录入、自动公式、数据整理、图表生成等功能,高效处理 Excel 任务,提升办公效率。支持自动高亮数据、批量计算、不规则数据录入,适用于企业、教育、金融等多场景。

下拉加载更多