Jamdesk Documentation logo

VS Code 扩展

通过 VS Code 状态栏一键启动、停止和重启 Jamdesk 开发服务器,并自动预览浏览器。

无需离开 Visual Studio Code 即可预览您的文档。Jamdesk 扩展在状态栏添加一个按钮,用于启动 jamdesk dev。它会监控服务器,并在服务器就绪时打开您的浏览器。

前置条件

  • 已安装 Jamdesk CLI(npm install -g jamdesk)
  • 包含 docs.json 文件的工作区

安装扩展

在 VS Code 扩展面板中搜索 Jamdesk(macOS 使用 Cmd+Shift+X,Windows/Linux 使用 Ctrl+Shift+X),然后点击 Install。或者从 VS Code 应用市场安装。

扩展会在包含 docs.json 文件的工作区中激活。状态栏中会出现一个播放按钮。

启动开发服务器

点击状态栏中的播放按钮。扩展将会:

  1. 将 jamdesk dev 作为子进程启动
  2. 监控输出,以检测服务器何时就绪
  3. 打开浏览器访问本地预览(如果启用了自动打开)

状态栏会显示当前服务器状态:启动中、运行中或已停止。

命令

打开命令面板(Cmd+Shift+P / Ctrl+Shift+P)并输入 "Jamdesk":

命令描述
Jamdesk: Start Dev Server启动开发服务器
Jamdesk: Stop Dev Server停止正在运行的服务器
Jamdesk: Restart Dev Server重启服务器
Jamdesk: Show Output显示 CLI 输出通道

设置

在 VS Code 设置(Cmd+, / Ctrl+,)中的 Jamdesk 下配置扩展:

设置默认值描述
jamdesk.port3000首选开发服务器端口
jamdesk.verbosefalse启用详细 CLI 输出
jamdesk.cleanfalse下次启动时清除构建缓存
jamdesk.browserModeexternal预览的打开位置:external(系统浏览器)或 embedded(VS Code 侧边面板)
jamdesk.autoOpenBrowsertrue服务器就绪时打开浏览器

将 browserMode 设置为 embedded,即可在 VS Code 侧边面板中打开文档预览。编辑与预览并排进行。

智能端口处理

当首选端口被占用时,CLI 会切换到下一个可用端口。扩展会从 CLI 输出中读取端口号,浏览器也会打开正确的 URL。

输出通道

扩展会将 CLI 输出流式传输到 Jamdesk 输出通道。您可以通过 Jamdesk: Show Output 命令或从输出面板下拉菜单中打开它。

用途包括:

  • 监控构建进度
  • 调试服务器问题
  • 查看详细日志(启用 jamdesk.verbose 时)

接下来做什么?

本地预览

基于 CLI 的预览,支持自定义端口和详细模式

CLI 概览

完整的 CLI 命令参考