创建和编辑页面

在 Web 编辑器中创建、编辑和组织文档页面。

​

浏览文件

在左侧面板的 Navigation 标签页中浏览文档页面。

• 点击导航元素以展开或折叠。
• 点击页面将在编辑器中打开它。
• 点击搜索 icon，或按下 Cmd + P（macOS）或 Ctrl + P（Windows），按文件名搜索文件。搜索将精确匹配文件名，因此请在单词之间使用连字符（例如，使用 get-agent-job 而不是 get agent job）。

​

查看未使用页面

侧边栏 Settings 部分底部的 Unused pages 区域会显示存在于你的存储库中、但未包含在导航中的页面和其他文件。这些是隐藏页面，在你将它们添加到导航之前，不会出现在已发布站点中。

​

创建新页面

1. 在要添加页面的导航区域中，点击 + 按钮。
2. 点击 Add a page。
3. 输入文件名，编辑器会自动添加 .mdx 扩展名。

​

将未使用页面添加到导航

可以将 Unused pages（未使用页面） 区域中的页面添加到导航中。

拖放操作：

1. 在 Unused pages（未使用页面） 区域中找到该页面。
2. 将页面拖拽到导航树中目标位置。

在导航树中：

1. 在你想添加文件的位置点击加号按钮 。
2. 点击 Add existing file（添加已有文件）。
3. 选择你想要添加的页面。

​

编辑内容

使用工具栏中的开关在可视化模式和 Markdown 模式之间切换。切换模式时，Web 编辑器会保存你的更改。

​

可视模式

在编辑内容时实时预览其发布后的效果。

• 添加文本：在编辑器中输入，查看文本在发布后如何呈现。
• 格式化文本：使用工具栏将文本加粗、设置为斜体或应用其他格式。
• 添加组件：按下 / 打开组件菜单并选择组件。
• 添加图片：从 / 菜单中使用 image 组件。
• 插入链接：选中文本并按 Cmd + K。

完整的可用组件列表请参见 Components。

​

Markdown 模式

编辑 MDX 源代码。

• 直接编辑 MDX：编写 MDX 和 Markdown 语法，以精确控制内容。
• 组件属性：设置组件属性和配置。
• Frontmatter：编辑文件顶部的页面元数据。

有关 MDX 语法的更多信息，请参阅 格式化文本 和 格式化代码。

​

配置页面

通过配置页面设置，可以控制页面在导航、搜索结果以及站点布局中的显示方式。

1. 右键单击文件。
2. 单击 Configure。

​

自定义导航外观

控制页面在站点导航侧边栏中的显示方式。

• 标题：设置主标题。会显示在导航、浏览器标签页和搜索结果中。
• 侧边栏标题：当完整标题在侧边栏中过长时，可以在导航中显示更短的文本。
• 图标：在页面旁边添加视觉标记，帮助用户快速识别。
• 外部 URL：链接到外部站点，而不是某个页面。使用此选项将外部资源添加到你的导航中。

​

为搜索和分享进行优化

帮助用户找到你的页面，并优化页面在被分享时的展示效果。

• Description：撰写简短摘要。会显示在搜索结果和 SEO（搜索引擎优化）元标签中。
• Keywords：添加相关搜索词，帮助用户更容易发现此页面。
• OG Image URL：为社交媒体分享和链接预览设置自定义预览图片。

​

控制页面布局

根据你的内容需求选择页面的展示方式。

• 标准布局（default）：带有侧边栏导航和目录的默认页面。
• 全宽布局（wide）：隐藏目录，为表格、图表或其他内容提供更宽的布局。
• 居中布局（center）：隐藏侧边栏和目录，以提升更新日志等文本较多页面的可读性。
• 自定义宽度（custom）：仅保留顶部导航栏的极简布局，适用于着陆页或其他特殊布局。

​

管理页面

​

移动页面

拖放页面即可在导航中调整顺序，或在文件树中在不同文件夹之间移动文件。

​

复制页面

右键单击该页面，然后选择 Duplicate。

​

删除页面

右键点击页面并选择 Delete。删除页面后，它会自动从导航中移除。

​

隐藏页面

要在不删除文件的情况下将页面从导航中移除，请右键单击该页面并单击 Hide Page。文件仍保留在你的存储库中，你可以通过将其添加到 docs.json 的导航中来取消隐藏该页面。