mkdocs-toolchain

My personal mkdocs toolchain, only for personal use.

我个人使用的 mkdocs 工具链，仅供个人使用、学习参考。

原创插件

自己写着玩的，可能有 bug，不过欢迎使用！

• TonyCrane/mkdocs-changelog-plugin
• TonyCrane/mkdocs-heti-plugin
• TonyCrane/mkdocs-statistics-plugin

未单独发布插件：

• mkdocs-linkbackward-plugin: 为了链接兼容性创建跳转页面
• mkdocs-tikzautomata-plugin: 在 markdown 中直接编写 tikz 并嵌入 svg，修改自 FrightenedFoxCN/mkdocs-mathenv-plugin
• mkdocs-toc-plugin: 从页面内嵌 yml 生成 toc（带字数统计/更新时间）

各包原始 commit sha

• mkdocs: 3e0949a332ee2d4e3b0256869a9c448b03ea944d (old: 730da08158b05374c4230f9785dd7f5068801fe3)
• mkdocs-encryptcontent-plugin: c28e4ce359cc3e69e097db8eba3fb77ab683b40d
• mkdocs-git-revision-date-localized-plugin: 9cfce40942c83dd15834fb879caa4171a426ecdd
• mkdocs-rss-plugin: 89e9cfa8262e9b40f571d554a75a2e9929264efc (old: 07975d6f4c27759d3bc7845427ac05fe49afd9c1)
• mkdocs-material: 不在此 repo 中，直接使用 8.1.4 版本（mkdocs-material-extensions 1.1）
• mkdocs-glightbox: 不在此 repo 中，直接使用 0.3.4 版本

各包做的修改

mkdocs

23.10.25 更新 mkdocs 后以下所有 patch 都在 2e21a9 中。

• 更新了 logger，使用 RichHandler 美化（324ef3）
• 不警告 todo.md 文件没包含在 nav 中 ⚠️ 个人限定（324ef3）（官方 not_in_nav 实现）
• 不要求对 html 文件的引用包含在文件树中 ⚠️ 个人限定（324ef3）（官方 validation 可实现忽略）
• 为文档构建的三个过程（渲染、构建、拷贝静态文件）增加进度条（6c8c36）
• serve 模式下不监控 .DS_Store 文件（0cbebe）
• 为 gh-deploy 增加 --skip-build 选项，用于跳过构建过程（610185）
• serve 模式下监控主题 overrides 文件夹 ⚠️ 硬编码（47ba34）（官方 --watch-theme flag 实现）

mkdocs-encryptcontent-plugin

• 将一些 info 级别的无关紧要 log 降低为 debug 级别（751ff1）
• 从加密页面中获取 summary、placeholder、encryption_info_message，而不是全部使用全局（59211c）

mkdocs-git-revision-date-localized-plugin

• 在 serve 模式下自动关闭插件，加速预览（d90259）

mkdocs-rss-plugin

• 在 serve 模式下自动关闭插件，加速预览（ef7f45）
• 规范地使用 logger（ef7f45）