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

网页编辑器工作流

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

选择分支

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

打开文件

在侧边栏中定位到现有文件,或使用文件浏览器新建文件。
3

编辑内容

在网页编辑器中进行编辑。试着使用右上角的切换按钮在可视化模式和 Markdown 模式之间转换,选择你更顺手的模式。
4

预览更改

可视化模式会展示更改在线上站点的呈现效果。用它来确认一切是否正确。
5

发布更改

如果你在部署分支上工作,可直接在网页编辑器中发布更改。在其他分支上,需要先创建拉取请求,审核通过后再发布。

编辑器模式

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

可视化模式

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

Markdown 模式

Markdown 模式可直接访问文档的底层 MDX 代码。当你需要精确控制组件属性,或更倾向于使用 Markdown 语法编写时,此模式最为理想。
Mintlify 网页编辑器中的 Markdown 模式

下一步