Skip to main content

Home 与 Publishing

编辑器工作区分为两个标签页:HomePublishing Home 是你的工作区,显示仓库中的内容文件,包括你的私有页面,无论它们是否出现在已发布的站点上。 Publishing 是你已发布的站点,显示访问者看到的导航以及站点设置。 Home 默认会隐藏部分文件,包括 docs.json、名称以点开头的文件和文件夹、没有扩展名的文件、像 README.md 这样的全大写 Markdown 文件,以及 .css.js.jsx.mjs.cjs.pdf 文件。若要查看全部文件,请启用 Show all files,或按 Cmd + Shift + .(macOS)或 Ctrl + Shift + .(Windows)。

创建页面

若要把页面添加到导航中,请在你想放置该页面的导航元素上点击 加号按钮,然后输入页面名称。编辑器会自动添加 .mdx 扩展名。

添加媒体

输入 /image/video 上传文件,或选择仓库中已有的文件。你也可以把文件从电脑拖放到页面上。若要复用媒体,请把图片或视频从导航树拖到页面上。
  • 上传的文件会保存到 images/videos/ 文件夹,并随下次发布一起提交。
  • 支持的格式为 PNG、JPG、JPEG、GIF、WebP、SVG、MP4 和 WebM。
  • 若要在浅色和深色模式下显示不同的图片,请将鼠标悬停在已插入的图片上并使用 Light/dark variants
  • 输入 /embed 并粘贴 YouTube、Loom 或 Vimeo 的 URL 即可生成 iframe。其他情况请切换到 Manual embed 以编写自定义 HTML。
有关图片格式和 Frame 组件的用法,请参阅图片与嵌入内容

组织导航

在 Navigation 视图中拖动元素即可重新排序或嵌套。发布时,编辑器会把你的更改写入 docs.json。有关每个导航元素的作用,包括 group、tab、anchor、dropdown、menu、product、version 和 language,请参阅导航
有些元素无法嵌套在其他元素中。例如,tabs 不能嵌套在 groups 中。编辑器会阻止无效的组合。
若要修改页面的标题、slug、描述或 layout,请从导航树中打开该页面的设置。有关各项设置的更多信息,请参阅页面

删除页面

若要删除页面,请点击页面右上角的 More options,然后点击 Move to trash。你也可以在导航树中通过页面的选项菜单删除页面。 删除页面会同时移除文件及其导航条目。尽管菜单项名为 Move to trash,但并没有可用于恢复页面的回收站视图。如果误删了页面,请使用删除后出现的撤销提示。删除操作会在你发布时提交到你的仓库,因此发布之后只能从仓库的历史记录中恢复该页面。 若要在不删除文件的情况下把页面从已发布的导航中移除,请在导航树中该页面的选项菜单里选择 Remove from publishing Viewers 无法删除页面。对于私有页面,菜单会显示 Delete page,并且删除会立即生效,因为私有页面不会提交到你的仓库。

版本历史

版本历史让你查看并恢复页面此前保存的版本。docs.json 不支持版本历史。 Viewers 可以查看和比较私有页面的已保存版本。Editors 和 admins 可以恢复这些版本。 只要内容与最近一次记录的版本不同,编辑器就会记录一条新条目。版本历史按分支划分,只能查看当前分支的版本历史。 若要查看版本历史,请点击页面右上角的 More options,然后点击 Version history 如果你恢复某个版本,页面上未保存的更改会被覆盖。恢复公开页面时,只会在当前分支上恢复。恢复私有页面时,会在所有分支上恢复。

私有页面

私有页面是位于 Home 标签页 Personal 分区中的草稿。它们仅你自己可见,不会提交到你的仓库,也永远不会出现在已发布的站点上。 若要创建私有页面或文件夹,请点击 Personal 分区标题上的 加号按钮,然后选择 New pageNew folder 把私有页面或文件夹拖入 workspace 后,协作者会立即可以访问它,但它不会被添加到站点导航中。
你无法把 workspace 中的内容移回 Personal 分区。把私有页面变为公开是不可逆的操作。