跳转至

Mind-City-Course

欢迎来到 Mind City Course 的文档站点。这里是首页,直接把 docs/index.md 的内容替换成你的课程内容即可。

本地预览

cd ~/Mind-City-Course
mkdocs serve

默认监听 http://127.0.0.1:8000,改 Markdown 后浏览器会自动刷新。

部署

推送到 main 分支即自动部署,无需手动操作:

git add -A && git commit -m "..." && git push

GitHub 通过 webhook 通知服务器拉取并重新构建,通常十几秒后 https://mind-city.com 即可看到更新。

构建使用 mkdocs build --strict,文档中存在坏链接或非法语法会导致构建失败——此时线上保持上一版内容,不会出现半成品页面。

新增页面

  1. docs/ 下新建 .md 文件,比如 docs/lesson-01.md
  2. mkdocs.ymlnav 里登记:
nav:
  - 首页: index.md
  - 第一课: lesson-01.md

主题能力速查

提示框

!!! note 开头,配合 admonition 扩展。还有 tip / warning / danger 等类型。

=== "标题" 做内容分页,左侧可切换。

同样支持代码块:

def hello(name: str) -> str:
    return f"Hello, {name}!"
  • 已完成的待办
  • 未完成的待办

支持 print("行内高亮") 图标 emoji。