Jamdesk Documentation logo

网页编辑器

无需克隆仓库或打开终端,即可在浏览器中编辑 Jamdesk 文档、预览 MDX 并提交到 GitHub 触发构建。

在 Jamdesk 仪表板中编辑文档,无需克隆仓库或打开终端。打开页面,在实时预览旁编辑其 MDX。将更改提交到 GitHub 分支。每次提交都会触发构建,与 git push 的效果相同。

屏幕截图显示的是英文界面。

它是本地预览和 VS Code 扩展的浏览器版本。随时随地快速编辑时,可以使用它。

Jamdesk 网页编辑器:左侧为页面导航,中间为 MDX 编辑器,右侧为实时预览

打开编辑器

在仪表板侧边栏中点击 Editor。编辑器会打开项目已连接的仓库和默认分支。

编辑器需要已连接的 GitHub 仓库和宽屏(桌面设备)。较窄的窗口会显示“需要更宽的浏览器”提示。每个项目所有者和团队成员都可以使用此功能,适用于所有套餐。

界面

面板功能
Navigation(左侧)网站的页面和分组,读取自 docs.json。筛选页面、打开 Configuration (docs.json) 编辑器,或点击 Add page。
Editor(中间)用于编辑已打开文件的 MDX 代码编辑器,支持语法高亮并显示字数。
Preview(右侧)页面实时渲染效果,会随输入内容更新。切换 Desktop / Mobile 和 Light / Dark,检查页面显示效果。

左上角会显示当前编辑的分支。使用分支选择器切换分支。

编辑页面

点击导航中的页面将其打开。在中间面板中编辑 MDX,预览会随输入内容更新。提交之前,编辑内容会作为本地草稿保留在浏览器中。切换页面不会丢失编辑内容。提交之前,任何内容都不会发送到 GitHub。

添加页面

点击 Add page,即可在编辑器中创建新页面:

  1. 选择起始模板。
  2. 输入标题。Jamdesk 会根据标题生成文件名。
  3. 选择导航分组。

新页面会以草稿形式打开。Jamdesk 会在一次提交中写入新的 .mdx 文件和 docs.json 导航条目。

提交更改

将待处理的更改提交到 GitHub,以发布这些更改:

1
打开提交对话框

点击 Commit。对话框会列出所有已更改的文件(一个页面、docs.json,或多个文件)。

2
编写提交消息

输入提交消息,或点击 Generate,让 Jamdesk 根据差异生成消息。

3
提交更改

Jamdesk 会将更改提交到当前分支并启动构建。可在项目的 Builds 页面跟踪构建状态。

点击 Revert 可放弃当前页面尚未保存的更改。此操作会恢复已提交的版本。

处理外部更改

编辑期间,如果有其他推送更新了当前分支,编辑器会发出提示。提交时,所有上游已更改的文件都会以三方合并的形式打开。请在其中协调两个版本。你的本地编辑不会被丢弃。

通过编辑器提交会在仓库中创建真实提交,并触发与从本机推送相同的构建流程。如果文档位于仓库的子目录中(单体仓库设置),编辑器会在该目录中读取和写入文件。

要求

要求详情
已连接 GitHub项目必须已连接仓库和分支。
桌面浏览器需要宽屏(约 1400px 或更宽)。编辑器不适用于移动设备屏幕宽度。
访问权限任何项目所有者或成员均可使用。常规写入限制(例如,订阅已逾期)仍然适用。

接下来做什么?

本地预览

使用 CLI 在本地预览和编辑

部署流程

了解提交后会发生什么