跳转到主要内容
编辑器侧边栏将你的页面分组到不同的分区中。
  • Navigation：站点导航中的页面和分组，在 docs.json 中定义。
  • Files：仓库中所有不在导航里的文件，包括图片、视频、OpenAPI 规范和 docs.json。
  • Recents：你最近打开的三个私有页面。
  • Starred：你已加星标的私有页面。若要给页面加星标，请打开其选项菜单并选择 Star。星标仅对你可见。
  • Personal：你的私有页面。
  • Shared with me：同事直接与你共享的页面。
Personal、Shared with me、Recents 和 Starred 只有在你创建私有页面或同事与你共享私有页面后才会显示。Recents、Starred 和 Shared with me 为空时会保持隐藏。
在 Base 中，Navigation 部分称为 Teamspace，并且 Personal 始终显示。
拖动分区标题可重新排序分区。点击分区标题可折叠或展开它。编辑器会将你折叠的分区保存到你的账户中，并将分区顺序保存到你的浏览器中。 顶部栏会随你打开的页面而变化。在站点页面上，它包含分支选择器、Preview 和 Publish。在私有页面上，它包含 Share。

​
创建页面

若要创建页面，请在你想放置该页面的位置点击 加号按钮，然后选择 New page。
  • Navigation 分区标题：在导航顶部添加一个新页面。
  • 分组或其他导航元素：在该元素内添加一个新页面。
  • Files 分区标题或 Files 中的文件夹：创建一个不在导航中的文件。
侧边栏底部的 New page 按钮同样会在导航顶部添加一个页面。
若要把仓库中已有的页面添加到导航中，请点击 加号按钮并选择 Add existing page。
相同的菜单还可以创建 group、tab、anchor、dropdown、version、language 和 product 等导航元素。有关每种元素的更多信息，请参阅导航。

​
编辑页面设置

直接在页面顶部设置页面的标题、描述和图标。将鼠标悬停在标题上方并点击 Add icon 即可选择图标或表情符号。当已设置图标的页面处于打开状态时，浏览器标签页会显示该图标。 若要设置其他项，请从侧边栏中打开页面的选项菜单，或点击页面右上角的 More options，然后选择 Page settings。Page settings 面板将设置分为以下几组：
  • URL：页面的路径和重定向 URL。更改路径会移动该文件。
  • Navigation：侧边栏标题、tag、mode 以及页面是否隐藏。
  • SEO & sharing：Open Graph 图片和关键词。
  • Thumbnails：页面社交预览图片的缩略图覆盖设置。除非你修改某项设置，否则它会使用继承的值。
Groups、tabs 和其他导航元素有各自的设置面板，例如 Group settings 和 Tab settings。可以从元素的选项菜单打开这些面板。Groups、tabs、anchors、dropdowns、products、versions、languages 和 menu items 也有 Thumbnails 部分，用于为该部分中的页面设置缩略图覆盖。有关具体设置的更多信息，请参阅页面。 在 Base 中，Page settings 面板还包含 Properties 部分，你可以在其中为页面添加负责人和自定义属性。

​
编辑 API 参考页面

frontmatter 中包含 openapi、openapi-schema 或 api 字段的页面会在编辑器中显示 endpoint 及其字段，与它们在已发布站点上的显示方式相同。编辑器会为这些部分标注 Generated from OpenAPI。你无法在编辑器中编辑这些部分。要更改它们，请更新你的 OpenAPI 规范或页面的 frontmatter。请参阅 OpenAPI 设置。 你可以在页面上 endpoint 和字段之间编写自己的内容。 如果页面的 frontmatter 中没有 description，编辑器会显示 OpenAPI 规范中该操作的描述。点击描述即可编辑。如果你修改了描述，编辑器会将你的文本保存为页面的 description，并在该页面上替换规范中的描述。

​
添加媒体

输入 /image 或 /video 上传文件，或选择仓库中已有的文件。你也可以把文件从电脑拖放到页面上，或从 Files 分区把图片或视频拖到页面上。
  • 上传的文件会保存到你的 images/、videos/ 和 files/ 文件夹中，并随下次发布一起提交。在插入上传之前，你可以编辑其文件路径。
  • 你可以上传 PNG、JPG、GIF、WebP、AVIF、ICO 和 BMP 图片，MP4、WebM 和 MOV 视频，以及 PDF 文件。SVG 文件无法在编辑器中上传。
  • 在文档项目中，每次上传的文件大小最多为 20 MB。Base 有其自身的文件上传限制。
  • 点击图片即可选中它。拖动图片可移动其位置，包括拖入或拖出 frames、cards、tabs 和 callouts 等组件。拖动图片边缘的控制柄可调整其大小。按 Delete 或 Backspace 可将其删除。
  • 若要在深色模式下提供另一张图片，请选中图片，点击 Edit Image，然后设置 Dark mode image。
  • 输入 /embed 添加嵌入内容。在 Video link 标签页中粘贴 YouTube、Loom 或 Vimeo 的 URL，或指向视频文件的直链。在 Embed code 标签页中粘贴 iframe 或其他嵌入代码片段。
有关图片格式和 Frame 组件的用法，请参阅图片和嵌入内容。

​
组织导航

在 Navigation 中拖动元素即可重新排序或嵌套它们。发布时，编辑器会把你的更改写入 docs.json。
有些元素无法嵌套在其他元素中。例如，tabs 不能嵌套在 groups 中。编辑器会阻止无效的组合。
若要选择多个项目，请按住 Shift 键点击以选中一段范围，或按住 Cmd 键点击（macOS）或按住 Ctrl 键点击（Windows）以添加或移除单个项目。拖动所选项或右键点击即可一次性移动、复制或删除所有选中的项。按 Esc 可清除选择。 若要将分组或其他元素转换为其他类型，请打开其选项菜单并选择 Convert to。 跨站点各分区显示的全局导航元素（例如 anchors 和 tabs）不在侧边栏树中。若要管理它们，请打开一个站点页面，点击侧边栏底部的 Site configuration，然后进入 Navigation。

​
从导航中添加和移除页面

把 Files 中的页面拖到 Navigation 中，即可在该位置添加它。将文件夹拖入则会把它作为分组添加。你也可以从文件的选项菜单中选择 Move to navigation。 若要在不删除文件的情况下把页面或分组从导航中移除，请把它从 Navigation 拖到 Files 中，或从其选项菜单中选择 Move to files。移动后会出现一个撤销提示。

​
文件

点击 Files 中的文件即可打开它。
  • 图片会在预览中打开。点击图片可放大。
  • 视频会在编辑器中播放。
  • docs.json 会以 source 模式打开。
  • 文本和代码文件（例如 YAML、JSON 和 CSS）会在 source 编辑器中打开。
  • 编辑器无法预览其他文件（例如字体和压缩包）。
若要上传文件，请把它们从电脑拖到 Files 分区。

​
移动页面

若要移动页面，请打开其选项菜单并选择 Move，或在页面打开时按 Cmd + Shift + P（macOS）或 Ctrl + Shift + P（Windows）。 你可以通过以下方式打开页面的选项菜单：
  • 打开的页面右上角的 More options。
  • 侧边栏中页面旁边的 菜单。
  • 在侧边栏中右键点击页面。
在选择器中，搜索可以过滤目标位置，展开文件夹和分组可以查看嵌套的目标位置，选择一个目标位置即可移动页面。 选择器提供的选项取决于该项目在侧边栏中的位置：
  • Navigation：页面和分组会移动到导航中的其他分组。移动分组时，其中的页面也会一并移动。
  • Files：页面会把其文件移动到其他文件夹。
  • Personal：私有页面和文件夹会移动到另一个私有文件夹，或移入 Navigation 以将其添加到你的站点。参见将页面移动到你的站点。
Editors 和 admins 可以移动 site 页面。你可以移动 Personal 中的私有页面和文件夹，但无法移动 Shared with me 中的页面。

​
将页面复制到其他项目

若要将页面复制到组织中的其他项目，请打开其选项菜单并选择 Copy to a project，然后选择目标项目。你必须拥有 editor 或 admin 角色，并且能够访问这两个项目。

​
删除页面

若要删除页面，请点击页面右上角的 More options，然后点击 Move to trash。你也可以从侧边栏中页面的选项菜单删除页面。 删除 site 页面会同时移除文件及其导航条目。删除后会出现带有 Undo 的提示。若要在不删除文件的情况下把页面从导航中移除，请改选 Move to files。 删除私有页面是不可撤销的。对于私有页面，More options 菜单会显示 Delete page。 Editors 和 admins 可以删除 site 页面。

​
版本历史

版本历史让你可以将页面与此前保存的版本进行对比并恢复其中一个版本。docs.json 不支持版本历史。 停止编辑页面约 10 秒后，编辑器会记录一个新版本。如果你持续编辑，编辑器至少每分钟记录一个版本。从 Git 仓库同步的更改也会创建版本，这些版本的作者显示为 Git sync。版本历史按分支划分，只能查看当前分支的版本历史。
  1. 点击页面右上角的 More options。
  2. 点击 Version history。
  3. 选择一个版本。编辑器会显示当前页面与该版本的差异。
  4. 若要恢复它，请点击 Restore this version。
若要退出对比，请点击 Exit comparison。 任何人都可以对比版本。Editors 和 admins 可以恢复 site 页面的版本。对于私有页面，你需要拥有该页面上的 Editor 或 Full Access 角色才能恢复某个版本。 恢复某个版本会替换页面当前的内容。恢复 site 页面时，只会在当前分支上恢复。恢复私有页面时，会在所有分支上恢复。

​
私有页面

私有页面是位于侧边栏 Personal 分区中的草稿。它们仅你自己可见，不会提交到你的仓库。它们会自动保存，没有发布步骤。除非你把它们移到 site 上，否则永远不会出现在已发布的站点上。 如果你已经在使用私有页面，可以点击 Personal 分区标题上的 加号按钮，然后选择 New page 或 New folder 来创建页面或文件夹。在站点中，只有拥有私有页面或曾有人与其共享私有页面的人才会看到 Personal。 若要将 Markdown 文件导入为私有页面，请把 Markdown 和 MDX 文件从电脑拖到 Personal 或某个私有文件夹中。 若要为私有文件夹设置图标或表情符号，请打开其选项菜单并选择 Change icon。从 Icons 标签页中选择图标，或从 Emojis 标签页中选择表情符号，或选择 Remove 清除它。

​
共享私有页面

若要共享私有页面，请打开它并点击顶部栏中的 Share。若要共享文件夹，请在侧边栏中打开其选项菜单并选择 Share。搜索同事并为每个人选择角色：
  • Full Access：编辑和共享。页面所有者还可以把它移到你的 site 上。
  • Editor：创建和编辑内容。
  • Commenter：查看和评论内容。
  • Viewer：仅查看内容。
在常规访问权限下，选择 Only people invited 或组织中的 Everyone at。只有拥有 Full Access 的人才能更改谁具有访问权限。 如果你对某个页面只有 Viewer 权限，请点击顶部栏中的 View only，然后点击 Request edit access。拥有 Full Access 的人可以批准该请求。 与你共享的页面会出现在 Shared with me 中。当同事直接与你共享页面或文件夹时，它也会出现在你的收件箱中。若要从侧边栏中移除某个页面，请打开其选项菜单并选择 Leave。

​
把页面移到 site 上

若要把私有页面添加到你的站点，请在侧边栏中打开其选项菜单，选择 Move，然后选择 Navigation 或其中的某个分组。你也可以将页面拖入 Navigation。你需要拥有 editor 或 admin 角色。 该页面会作为未发布的更改移入你当前分支上的导航中，侧边栏会高亮显示它。发布后它才会上线。 移动文件夹会把它作为分组添加到导航中，并保留其所有页面和图标。每次最多可以移动 20 个页面。
把页面移到站点是单向的。私有页面会被立即移除，即使在分支上放弃该更改也无法恢复它。你无法把 site 页面移回 Personal。