Home

🎉 Zensical中文教程 —— 最新zensical中文教程 了解更多 →
✈️ 好用机场 —— 季付低至22元|70+国家线路 千兆带宽|支持流媒体|8折优惠码:VPN07
✨ 欢迎了解 mkdocs-materialx —— 新版MkDocs主题 仓库地址| Wechat 群组
最好的MkDocs中文教程
  • 导航栏


    image

    • 简洁美观 ,功能多元化,小白配置
    • 基于Material for MkDocs美化
    • 如遇页面卡顿,请使用科学上网
    • 𝕙𝕒𝕧𝕖 𝕒 𝕘𝕠𝕠𝕕 𝕥𝕚𝕞𝕖 !

    请在上方标签选择分类/左侧目录选择文章

    请点击左上角图标选择分类和文章

不同于市面上过时的MkDocs教程,本站提供了最详细最便捷最前沿的MkDocs中文文字/视频教程,与官方发布的教程版本同步。包含了MkDocs的安装、配置、主题美化、插件使用等内容。无论你是初学者还是有经验的用户,都能在这里找到你需要的帮助。我们还提供了示例和实用的技巧,帮助你更好地使用MkDocs。𝓳𝓾𝓼𝓽 𝓮𝓷𝓳𝓸𝔂 𝓲𝓽~

重要提醒

Mkdocs for material已经进入维护状态,materialX作为mkdocs的延续被广泛使用,本站作为mkdocs教程站迁移至materialX主题。 Zensical是 mkdocs for material原作者的延续,提供了更丰富的功能和更现代的UI设计,可以考虑迁移至Zensical主题,我不再更新mkdocs for material教程。


2026.3 目前 https://github.com/ProperDocs 作为新的mkdocs延续下去了,我只能说mkdocs圈真乱,本UP主已经全面拥抱Zensical了。吃瓜请去这里MKDocs 的缓慢崩溃。所以如果使用mkdocs,我首先还是推荐materialX

2.Mkdocs配置说明(mkdocs.yml)
官方文件:Changing the colors - Material for MkDocs 建议详细学习一下上面的官方网站↑↑↑ 我把我目前的配置文件mkdocs.yml代码写在下面👇🏻 从头开始分析 无须多言 theme部分 顶部颜色 primary后面是网站顶部栏目的颜色(也用于标题、边栏、文本链接和其他几个组件) 目前支持下面几个颜色: 明暗主题按钮
2022网站更新记录

2022-10-20

建立Github仓库,正式建站 取消cookie确认,简化网站打开流程 新增首页反馈收集

2022-10-06

不靠父母,全款拿下 wcowin.work域名 取消cookie确认,保障隐私

2022-06-06

研究如何建设网站,初步定框架为MKdocs 早期网址:
2023网站更新记录

2023-12-21

优化网站流畅度(玄学) 脱单了;手执烟火以谋生,心怀诗意以谋爱

2023-12-14

优化个别网页标签的显示问题 优化网站图片加载流畅度(玄学) 看了更多的猫咪

2023-12-09

首次引入人工智能问答机器人:,缺点是每月25条消息限制,优点是可以智能回复本站所有信息,包括但不限于:个人信息,技术分享,博客,留言板,友链等等 优化网站流畅度

2024网站更新记录

2024-12-24

优化网站流畅度(玄学) 优化了注脚显示效果 删除了一些冗余代码

2024-12-10

优化网站流畅度(玄学) 启用 CDN 加速

2024-07-21

优化网站流畅度(玄学)

2024-07-21

为MKdocs添加AI摘要(Plus版本)
🚀 您的MkDocs文档首选智能摘要! 这个项目利用MkDocs hooks,为您的技术文档和博客添加AI驱动的摘要生成和智能阅读统计功能。 🌟 为什么选择这个插件? - 🤖 多 AI 服务支持 - 支持 DeepSeek、OpenAI、Google Gemini、GLM 等主流 AI 服务 - ⚡ 智能缓存系统 - 避免重复 API 调用,大幅提升构建速度 - 🌍 多语言支持 - 支持中英文等多种语言,页面级语言控制 - 🔄 自动降级机制 - 主服务不可用时自动切换备用服务,确保稳定性 - 🚀 CI/CD 友好 - 专为持续集成环境优化,支持缓存策略 - 🎨 完美兼容 - 与所有 MkDocs 主题无缝集成 安装
MkDocs文档AI摘要
仓库地址:https://github.com/Wkwcowin/Mkdocs-AI-Summary 🌐 在线演示:https://wcowin.work/Mkdocs-AI-Summary-Plus/ 🚀 您的MkDocs文档首选智能摘要! 这个项目利用MkDocs hooks,为您的技术文档和博客添加AI驱动的摘要生成和智能阅读统计功能。 ✨ 功能特性 🤖 AI智能摘要 - 多AI服务集成: 支持DeepSeek、OpenAI、Claude、Gemini等主流AI服务 - 自动摘要生成: 生成高质量的80-120字智能摘要 - 多语言支持: 支持中文、英文、双语摘要生成 - 智能内容清理: 自动过滤YAML、HTML、代码块等格式内容
添加评论系统(giscus为例)
官方文档:Adding a comment system 这里我同样推荐giscus 利用 GitHub Discussions 实现的评论系统,让访客借助 GitHub 在你的网站上留下评论和反应吧!本项目深受 utterances 的启发。 开源。🌏 无跟踪,无广告,永久免费。📡 🚫 无需数据库。所有数据均储存在 GitHub Discussions 中。:octocat: 支持自定义主题!🌗 支持多种语言。🌐 高可配置性。🔧 自动从 GitHub 拉取新评论与编辑。🔃
嵌入PDF文件
嵌入PDF代码 ,注意PDF的相对地址 我的完整代码: 希望对你有帮助
网页圆角化设计
示例 如何设计 新建css文件,在mkdocs.yml引入css 图片圆角化 extra.css里引入: 在md文件里使用: 效果: 圆角边框 利用内置的grid cards 效果:
MKDocs 的缓慢崩溃
本文译者:shenweiyan 2026 年 3 月 9 日, MkDocs 的一位前维护者接管了 PyPI 代码库的控制权,并撤销了原作者的权限。原作者迅速作出回应: 然后他们提交了一份 PyPI 支持工单 以重新获得控制权,但在工单得到处理之前,问题就已得到了解决。 MkDocs 为超过 90,000 个 GitHub 项目提供文档支持,其中大多数项目都依赖于由 @squidfunk 开发的 Material for MkDocs 主题,该主题非常受欢迎,其获得的星标数甚至超过了 MkDocs 本身。 PyPI 被接管事件不过是更深层次问题的一个最为显眼的症状表现。如今,任何使用 Material for MkDocs 的人都会在终端中看到以下警告信息: MkDocs 项目已经超过 18 个月没有进行任何实质性的开发。Material for MkDocs 目前处于维护模式。而曾经两大主导工具携手共进的局面已不复存在,如今有多款工具竞相涌现,试图取而代之:如 ProperDocs、MaterialX("新一代的 mkdocs-material")以及 Zensical("由 Material for MkDocs 开发者打造的现代化静态网站生成器")。 我们怎么会走到这一步?要了解事情的全貌,我们需要稍微回顾一下过去 …… 2014年1月11日 - MkDocs 的诞生 2014 年 1 月 11 日,Mia Kimberly Christie( @lovelydinosaur )提交了第一个代码 ,也就是后来的 MkDocs,并附上了 "Hell yeah" 的消息。接下来的几个月里,提交数量激增。 这种活跃期并没有持续太久。到 2014 年年中,他们在代码库中的活动就完全停止了。

欢迎加我微信入交流群!

微信

Telegram