跳转至

文档(MkDocs)

这是 TorchView 项目的文档说明。文档站点基于 MkDocs 构建。

常用命令

  • mkdocs new [dir-name]:创建一个新的 MkDocs 项目
  • mkdocs serve:启动本地预览(支持热更新)
  • mkdocs build:构建静态站点
  • mkdocs -h:查看帮助并退出

项目结构

mkdocs.yml    # 配置文件
docs/
    index.md  # 文档主页
    ...       # 其他 Markdown 页面、图片等资源