Jamdesk Documentation logo

本地预览

使用 Jamdesk CLI 在推送到生产环境前于本机预览文档,编辑时修改会即时显示。

在任何包含 docs.json 的目录中运行 jamdesk dev(或 npx jamdesk dev),即可启动本地服务器,支持热重载、完整搜索,并确保所有组件与生产环境中的运行方式完全一致。

前置条件

开始前,请确保具备以下条件:

  • Node.js 20+ - 使用 node --version 检查
  • 文档项目 - 包含 docs.json 配置文件

启动开发服务器

全局安装 CLI,然后从文档目录运行:

npm install -g jamdesk
cd your-docs
jamdesk dev

文档将在 http://localhost:3000 提供访问。

可用功能

热重载

编辑 MDX 文件后即可立即查看更改。编辑 docs.jsonstyle.css 后,刷新页面即可加载更改。

完整搜索

使用实际内容测试 Cmd+K 搜索

所有组件

每个组件的运行方式都与生产环境完全一致

主题切换

测试浅色和深色模式

自定义端口

默认端口为 3000。如果该端口已被占用,请指定其他端口:

jamdesk dev --port 3001

或者在 ~/.jamdeskrc 中设置永久默认端口:

{
  "defaultPort": 3001
}

详细模式

使用 --verbose 标志查看详细的构建信息:

jamdesk dev --verbose

此模式会显示:

  • 文件更改检测
  • 构建耗时
  • 导航解析
  • 任何警告或错误

首次运行性能

首次运行 jamdesk dev 时,系统会将依赖项安装到 ~/.jamdesk。此过程需要 30–60 秒。后续运行将在 5 秒内启动。

要清除缓存并强制重新安装:

jamdesk clean
jamdesk dev

故障排除

其他进程正在使用端口 3000。

选项 1: 使用其他端口

jamdesk dev --port 3001

选项 2: 查找并停止该进程

lsof -i :3000
kill -9 <PID>

确保当前位于包含 docs.json 文件的目录中:

ls docs.json  # Should show the file
jamdesk dev

尝试以下步骤:

  1. 检查终端中是否有错误
  2. 强制刷新浏览器(Cmd+Shift+R)
  3. 重启开发服务器
  4. 运行 jamdesk clean,然后重试

运行诊断:

jamdesk doctor

此命令会检查环境并识别问题。

接下来做什么?

VS Code 扩展

从 VS Code 状态栏启动开发服务器

部署

了解构建和部署流程