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/

相关推荐
Hommy884 小时前
【开源剪映小助手】字幕接口
开源·github·aigc·剪映小助手·视频剪辑自动化
一袋米扛几楼986 小时前
【Git】规范化协作:详解 GitHub 工作流中的 Issue、Branch 与 Pull Request 最佳实践
前端·git·github·issue
尘埃落定wf7 小时前
# GitHub CLI:告别繁琐的 Git 命令,让开发更高效
git·github
zh_xuan7 小时前
上传api调试工具到github
github
AIMath~9 小时前
彻底删除 GitHub 仓库中特定文件夹的完整指南
github
DogDaoDao10 小时前
【GitHub】OpenClaw:开源个人AI助手的新标杆
人工智能·深度学习·开源·大模型·github·ai编程·opeclaw
一点一木18 小时前
🚀 2026 年 4 月 GitHub 十大热门项目排行榜 🔥
人工智能·github
宝桥南山20 小时前
AI - 在命令行中尝试一下ACP(Agent Client Protocol)通信
microsoft·微软·github·aigc·copilot
拾贰_C1 天前
【Github | GitHub Copilot | 学生认证】 GitHub Copilot学生如何认证
github
旅之灵夫1 天前
【GitHub项目推荐--OpenArm:开源7自由度仿人机械臂平台】
github