使用侧边栏文件浏览器浏览文档文件。单击任意文件即可在编辑器中打开。 Command + P(Windows 上为 Ctrl + P)按名称搜索文件。

创建新页面

1

创建新文件

在文件资源管理器侧边栏中选择“Create a new file”图标。网页编辑器中的文件菜单
2

输入文件名

文件名必须以 .mdx 结尾,例如 api-reference.mdxgetting-started.mdx
3

创建并打开

Enter 创建文件。文件会自动在编辑器中打开,等待你添加内容。

组织导航

通过编辑 docs.json 文件,将新页面添加到站点导航中。
1

打开 docs.json

使用文件资源管理器在项目根目录中找到并打开 docs.json 文件。
2

定位 navigation 区域

docs.json 文件中找到你希望添加新页面的位置。
3

添加页面

在对应分组的 pages 数组中插入页面文件名(不包含 .mdx 扩展名)。

示例:添加一个 themes 页面

将 themes 页面添加到 Profile 组
{
    "navigation": {
        "groups": [
            {
                "group": "Getting started",
                "pages": [
                    "index",
                    "quickstart", 
                    "installation"
                ]
            },
            {
                "group": "Profile",
                "pages": [
                    "settings",
                    "account-types", 
                    "dashboard",
                    "themes"
                ]
            }
        ]
    }
}

编辑内容

在编辑器中使用可视化模式或 Markdown 模式修改页面。 在可视化模式下,按 / 打开组件菜单。添加内容块、提示、代码块以及其他组件,来自定义文档。
Mintlify 网页编辑器中展开的组件菜单(高亮显示)
在 Markdown 模式下,你可以直接编辑页面的 MDX。在以下场景中会很有帮助:
  • 设置特定组件属性
  • 处理复杂的嵌套组件
  • 从其他来源复制并粘贴 MDX 内容