快速入门

部署你的文档站点并完成首次更改。

完成本指南后，你将拥有一个已上线的文档站点，可以开始对其进行自定义和更新。

​

开始之前

Mintlify 使用“文档即代码”（docs-as-code）的方法来管理你的文档。站点上的每个页面都有一个对应的文件，存储在你的文档存储库中。你可以使用自己的 Git 存储库，或使用 Mintlify 托管的存储库。

选择你要使用的存储库方案。

Mintlify 托管

Mintlify 会创建一个私有 GitHub 存储库，并将其连接到你的 Mintlify 部署。

如果满足以下情况，请选择此选项：

• 你只会在 Web 编辑器中工作，并且不想在本地使用 Git。
• 你想要快速开始，而不需要先连接存储库。
• 你希望由 Mintlify 来为你管理文档存储库。

你自己的存储库

将你自己的 Git 存储库连接到你的 Mintlify 部署。

如果满足以下情况，请选择此选项：

• 你将在本地工作，并希望与远程存储库进行同步。
• 你已经有一个用于文档的存储库。
• 你希望文档位于你自己的 GitHub 组织下。

不确定该选哪一个？先从 Mintlify 托管 开始。如果之后发现使用自己的存储库更适合你的需求，你可以随时迁移过去。

​

部署文档站点

由 Mintlify 托管

1. 创建账号

   前往 mintlify.com/start 并创建你的账号。

2. 跳过 GitHub 连接

   当系统提示连接 GitHub 时，点击 Skip，以使用由 Mintlify 托管的存储库。

3. 完成初始设置

   按照引导流程完成文档配置。Mintlify 会在 mintlify-community 组织中自动为你创建一个私有存储库，并为你配置 GitHub 应用。

4. 站点已部署

   你的文档会立即完成部署，并可通过你的 .mintlify.app URL 访问。

使用你自己的存储库

1. 创建账号

   前往 mintlify.com/start 并创建你的账号。

2. 连接 GitHub

   在系统提示时，登录你的 GitHub 账号并完成认证。

3. 完成初始设置

   按照剩余的引导步骤创建存储库，并继续进入你的控制台。

4. 安装 GitHub 应用

   安装 Mintlify GitHub App 以启用自动部署。这样 Mintlify 就可以与你的存储库同步，并在你推送更改时自动部署。

5. 可选：选择存储库

   如果你希望为文档使用引导过程中创建的存储库以外的其他存储库，可以在控制台的 Git settings 页面中进行选择。你的文档存储库必须包含有效的 docs.json 文件才能进行部署。

6. 站点已部署

   你的文档已部署完成，并可通过你的 .mintlify.app URL 访问。之后推送到存储库的更改会自动触发新的部署。

要进一步了解 GitHub 应用及其权限，请参阅 GitHub。

​

查看你已部署的网站

你的文档站点现在已部署在 https://<your-project-name>.mintlify.app。

在 控制台 的 Overview 页面中可以找到准确的 URL。

你的网站已经可以立即访问。使用这个 URL 进行测试并与团队分享。在面向正式用户分享之前，你可能希望先添加一个自定义域名。

​

完成你的第一次修改

1. 打开网页编辑器

   在控制台中前往 web editor。

2. 编辑页面

   打开 index.mdx，在 frontmatter 中更新 description 字段：

   ---
   title: "Introduction"
   description: "Your custom description here"
   ---
   
3. 发布

   点击网页编辑器工具栏右上角的 Publish 按钮。

4. 查看线上效果

   在控制台的 Overview 页面中，你可以查看站点的部署状态。部署完成后，刷新你的文档站点即可看到最新的变更。

​

后续步骤

了解 Web 编辑器

探索编辑功能和工作流程。

设置本地开发环境

使用命令行界面（CLI）在撰写和编辑文档时进行本地预览。

添加自定义域名

为你的文档站点使用自有域名。