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的工作流中执行插件安装,即"云"上也有你这个插件,这个插件库不只是存在于本地,网站说到底是发布在网上的,别人无法使用你本地电脑的插件)

好几位朋友私信甚至发邮箱([email protected])问我一些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/

相关推荐
Gladiator5758 小时前
博客记录-day152-力扣+分布式
github
jstart千语8 小时前
【Git】连接github时的疑难杂症(DNS解析失败)
git·github
fanTuanye10 小时前
Git基本使用(很详细)
git·github
Evenknow10 小时前
将"修改源码"改为更专业的"二次开发",体现技术深度
前端·github
uhakadotcom11 小时前
rAthena:快速入门与基础知识详解,附实用示例代码
面试·架构·github
qianmoQ13 小时前
GitHub 趋势日报 (2025年04月24日)
github
前端太佬17 小时前
从拧螺丝到造火箭:Git高阶玩家生存报告
前端·git·github
前端太佬17 小时前
从青铜到塑料:Git逃难指南(附救命指令大全)
前端·git·github
uhakadotcom20 小时前
跨越速运日调用千万,秒级响应!Flink + OceanBase 实时分析方案全解析
后端·面试·github
uhakadotcom20 小时前
marimo Python笔记本:让Python交互式编程更简单、更可靠
后端·面试·github