浅色模式下的 Mintlify 网页编辑器界面 网页编辑器是在浏览器中直接用于创建、编辑和审阅文档的可视化界面。
  • 可视化编辑:使用所见即所得(WYSIWYG)编辑器修改文档,实时查看发布后的呈现效果。
  • Git 同步:所有更改会自动同步到 Git 仓库,确保版本控制。
  • 团队协作:支持多人同时协作编写文档。
  • 组件集成:通过斜杠命令添加提示、代码块等组件。
  • 零配置:可在控制台立即开始写作。

网页编辑器工作流

以下是在网页编辑器中的常见工作方式:
1

选择分支

创建一个分支,或直接在部署分支上修改。我们建议先创建分支,这样可以在更改上线前进行预览。
2

打开文件

在侧边栏定位到现有文件,或使用文件资源管理器创建新文件。
3

编辑内容

在网页编辑器中进行修改。试着使用右上角的开关在可视化模式和 Markdown 模式之间切换,看看你更偏好哪种模式。
4

预览更改

可视化模式会显示你的更改在线上站点中的呈现效果。用它来确认一切无误。
5

发布更改

如果你在部署分支上工作,可直接在网页编辑器中发布更改。若在其他分支上,请先创建 pull request 进行审核,再发布。

编辑器模式

网页编辑器提供两种模式,以满足不同的编辑偏好和需求。使用编辑器工具栏右上角的切换按钮在两种模式间切换。
网页编辑器中高亮显示的模式切换图标。

可视化模式

可视化模式提供所见即所得(WYSIWYG)体验:你在编辑器中的更改将直接发布到文档站点。此模式非常适合需要实时预览更改效果的场景。 按下 / 打开组件菜单,添加样式化内容、提示、代码片段或其他组件。
Mintlify 网页编辑器中的可视化编辑模式

Markdown 模式

Markdown 模式可直接访问文档底层的 MDX 代码。该模式非常适合在需要精细控制组件属性,或偏好使用 Markdown 语法编写时使用。
Mintlify 网页编辑器中的 Markdown 模式

下一步