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/

相关推荐
CoderJia程序员甲9 小时前
GitHub 热榜项目 - 日榜(2025-12-9)
ai·开源·大模型·github·ai教程
知行力10 小时前
【GitHub每日速递 20251209】Next.js融合AI,让draw.io图表创建、修改、可视化全靠自然语言!
javascript·人工智能·github
徐小夕11 小时前
知识库创业复盘:从闭源到开源,这3个教训价值百万
前端·javascript·github
jiaoxingk12 小时前
如何丢弃本地修改并恢复为 GitHub 最新版本
github
im_AMBER14 小时前
github pages 配置踩坑
笔记·学习·github
猫头虎15 小时前
openEuler异构算力体系下的GPU加速性能测试与优化研究
开源·github·aigc·ai编程·ai写作·gpu算力·华为snap
达子66618 小时前
笔记-使用Repo工具管理多个关联仓库(适用于复杂项目)
git·gitee·github
逛逛GitHub18 小时前
建议去 GitHub 学这 6 个项目,打破 Agent 的信息差。
github