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/

相关推荐
2401_864476931 小时前
无线领夹麦克风哪个降噪好?一文搞懂麦克风什么牌子的音质效果好
javascript·git·sql·github·mssql
GoppViper1 天前
golang学习笔记29——golang 中如何将 GitHub 最新提交的版本设置为 v1.0.0
笔记·git·后端·学习·golang·github·源代码管理
贩卖纯净水.2 天前
白月光git
git·github
AI逍遥子2 天前
如何从github上clone项目
github
iBaoxing2 天前
如何在 Fork 的 GitHub 项目中保留自己的修改并同步上游更新?github_fork_update
github
The Mr.Nobody3 天前
打通最后一公里:使用CDN加速GitHub Page的访问
github
Amagi.3 天前
如何将本地项目上传到GitHub(SSH连接)
github
白总Server3 天前
php语言基本语法
开发语言·ide·后端·golang·rust·github·php
网安詹姆斯3 天前
网络安全(黑客技术)2024年三个月自学计划
网络·数据结构·python·mysql·安全·web安全·github
爱吃番茄的小狐狸3 天前
Docker镜像下载-使用github action- 解决无法下载docker镜像的问题
docker·容器·github