Mkdocs中文系列教程补充(1)

什么是requirements.txt

我的理解是mkdocs依赖的py库

第一次建立MKdocs文档使用

复制代码
mkdocs new .

完后,比较建议执行一下:

复制代码
pip install -r requirements.txt

不然mkdocs serve后会出现什么 xxx not found ,比如下面这位老哥

示例

复制代码
mkdocs
mkdocs-material
pymdown-extensions
mkdocs-encryptcontent-plugin
jinja2    //我自己安装的插件(自选)
jieba    //我自己安装的插件(自选)
mkdocs-glightbox    //我自己安装的插件(自选)
urllib3<2
mkdocs-git-committers-plugin-2      //我自己安装的插件(自选)
mkdocs-markdownextradata-plugin    //我自己安装的插件(自选)
mkdocs-git-revision-date-localized-plugin //我自己安装的插件(自选)
mkdocs-open-in-new-tab    //我自己安装的插件(自选)

注意!!如果你想部署到Github 还需要在ci.yml中如下图所示对应写上你使用的插件的安装语句

比如 - run: pip install mkdocs-open-in-new-tab

(我的理解是执行pip install -r requirements.txt是为了本地mkdocs serve后可以预览安装的插件,但是我们的网站是部署在Github,所以需要在Git的工作流中执行插件安装,即"云"上也有你这个插件,这个插件库不只是存在于本地,网站说到底是发布在网上的,别人无法使用你本地电脑的插件)

好几位朋友私信甚至发邮箱(wcowin@qq.com)问我一些MKdocs的小问题,虽然很小但是却影响整个MKdocs构建操作的进行,我决定作为Mkdocs中文系列教程补充内容更新,不会像正式教程的文字那样规矩,因为会掺杂我的一些理解(我也有很多不懂)

这是补充系列第一期,谢谢大家~


对MKdocs主题博客感兴趣的可以去看我写的Mkdocs系列教程(可以帮助你从头到尾构建起你的个人博客)https://blog.csdn.net/m0_63203517/category_12472184.html?spm=1001.2014.3001.5482https://blog.csdn.net/m0_63203517/category_12472184.html?spm=1001.2014.3001.5482

我的博客地址:https://wcowin.work/

相关推荐
sunny8657 小时前
Claude Code 跨会话上下文恢复:从 8 次纠正到 0 次的工程实践
人工智能·开源·github
ZengLiangYi12 小时前
Git Tag + Semver + CI/CD:从打标签到自动发布的完整实践
github
徐小夕14 小时前
JitWord Office预览引擎:如何用Vue3+Node.js打造丝滑的PDF/Excel/PPT嵌入方案
前端·vue.js·github
程序员鱼皮14 小时前
离大谱,我竟然在 VS Code 里做了个视频!
github·aigc·ai编程
答案answer16 小时前
一个非常实用的Three.js3D模型爆破💥和切割开源插件
前端·github·three.js
草梅友仁18 小时前
墨梅博客 1.7.0 发布与 AI 开发实践 | 2026 年第 9 周草梅周报
开源·github·ai编程
ursazoo1 天前
写了一份 7000字指南,让 AI 帮我消化每天的信息流
人工智能·开源·github
小兵张健1 天前
Playwright MCP 截图标注方案调研(推荐方案1)
前端·javascript·github