跳转到主要内容
此仓库是为 Mintlify 文档站点准备的。已发布的手册页面以 MDX 为主，而仅供 GitHub 使用的运维文件，如 README.md、CONTRIBUTING.md、SECURITY.md 和 SUPPORT.md，则保持为 Markdown。

​
本地预览

Mintlify 当前的 CLI 需要 Node.js 20.17.0 或更高版本。 从仓库根目录运行本地预览： 
npx mint dev
发布前运行质量检查： 
npx mint validate
npx mint broken-links

​
部署

主 Mintlify 部署应通过 Mintlify GitHub 应用连接。Mintlify 会读取 docs.json，并在推送更改时发布文档站点。 如果手册应显示在 Vercel 拥有的域名下，请在 Mintlify 子域名存在后，将 Vercel 配置为反向代理： 
{
  "rewrites": [
    {
      "source": "/docs",
      "destination": "https://YOUR-MINTLIFY-SUBDOMAIN.mintlify.dev/docs"
    },
    {
      "source": "/docs/:match*",
      "destination": "https://YOUR-MINTLIFY-SUBDOMAIN.mintlify.dev/docs/:match*"
    }
  ]
}
在确认真实的 Mintlify 子域名前，不要添加那个已启用的 vercel.json。

​
兼容性策略

Mintlify 是面向学生的阅读层。它应该发布精选的 MDX 页面，而不是每一个原始项目工件。
工件类型仓库策略网站策略
MDX 页面作为源文档提交并维护通过 docs.json 发布精选页面
GitHub 运维 Markdown仅保留给 README、贡献、支持、安全和模板等 GitHub 原生场景仅在需要时从站点链接
Python 源码作为 starter/source code 提交从指南页面链接，或之后将选定文件转换为教程页面
Jupyter notebooks除非有意提升，否则不要放入手册仓库在发布为课程前将选定 notebook 转换为 MDX
HTML/CSS/JS 示例当它们是源文件或演示时提交链接到 GitHub，或单独托管精选演示
已构建的 HTML/输出文件默认避免发布仅在有意作为演示推广时单独托管
原始参考资料默认保留在已发布站点之外，并由此仓库忽略使用 .mintignore 将其排除在公开文档站点之外
仓库级 .gitignore 会有意忽略原始 references/ 归档。等这些内容准备好面向学生站点时，再将选定材料提升为 MDX 页面。