你现在的 gh-pages 分支 + GitHub Pages 部署,带来了5个核心好处,全是实实在在的便利:
2. ✅ 「写笔记 = 自动生成在线文档」,彻底告别本地文件¶
- 你在本地
docs/里改 Markdown 笔记 - 运行
mkdocs gh-deploy→ 网站自动更新 - 不用手动传 HTML、不用管服务器、不用维护
- 笔记和网站完全同步,永远是最新版
3. ✅ 两个分支分工明确,开发和上线彻底分离¶
| 分支 | 作用 | 好处 |
|---|---|---|
main 分支 |
存放你的原始 Markdown 源码(笔记、配置) | 方便你本地修改、版本管理、回滚 |
gh-pages 分支 |
存放 MkDocs 生成的纯静态网站文件(HTML/CSS/JS) | 专门给 GitHub Pages 用,不污染源码 |
好处:
- 开发(写笔记)和上线(网站)完全分开,互不干扰
- 源码和成品分开管理,专业、规范、易维护
- 以后你只需要维护 main 分支,gh-pages 自动生成
4. ✅ 版本控制 + 历史回溯,再也不怕丢笔记¶
- 所有修改都有 Git 记录,随时可以回滚到任意版本
- 误删、改错,一键恢复,零风险
- 团队协作、多人编辑也完全支持(你现在是个人用)
5. ✅ 一键部署,零配置、零维护,彻底解放双手¶
mkdocs gh-deploy一条命令,自动完成:- 构建静态网站
- 推送到
gh-pages分支 - 上线 GitHub Pages
- 不用写配置、不用管服务器、不用懂运维
- 以后每次更新笔记,只需要这一条命令,网站自动更新
🚀 给你做「一句话总结」¶
你现在的操作,相当于:¶
把「本地的 CSS 笔记」 → 变成「一个全球可访问的专业在线文档站」¶
而且免费、自动、永久、零维护!¶
🎯 你现在已经达成的成就:¶
✅ 解决了 MkDocs 实时刷新的 click 版本BUG ✅ 解决了所有锚点警告,网站干净无错 ✅ 成功部署到 GitHub Pages,拥有个人在线网站 ✅ 掌握了 MkDocs 从本地开发 → 线上部署的完整流程
💡 给你一个「后续使用的最佳实践」¶
以后你更新笔记,只需要这 3 步:
1. 在本地 docs/ 里修改 Markdown 笔记
2. 运行 git add . && git commit -m "更新笔记"(同步源码到 main 分支)
3. 运行 mkdocs gh-deploy(自动更新网站到 gh-pages 分支)