Mind-City-Course¶
欢迎来到 Mind City Course 的文档站点。这里是首页,直接把 docs/index.md 的内容替换成你的课程内容即可。
本地预览¶
默认监听 http://127.0.0.1:8000,改 Markdown 后浏览器会自动刷新。
部署¶
推送到 main 分支即自动部署,无需手动操作:
GitHub 通过 webhook 通知服务器拉取并重新构建,通常十几秒后 https://mind-city.com 即可看到更新。
构建使用 mkdocs build --strict,文档中存在坏链接或非法语法会导致构建失败——此时线上保持上一版内容,不会出现半成品页面。
新增页面¶
- 在
docs/下新建.md文件,比如docs/lesson-01.md - 在
mkdocs.yml的nav里登记:
主题能力速查¶
提示框
用 !!! note 开头,配合 admonition 扩展。还有 tip / warning / danger 等类型。
- 已完成的待办
- 未完成的待办
支持 print("行内高亮") 和 图标 emoji。