本地预览
在推送到生产环境之前,使用 Jamdesk CLI 在本机预览文档。编辑时修改即时可见。
在包含 docs.json 的目录中运行 jamdesk dev(或 npx jamdesk dev)。它会启动一个支持热重载和搜索的本地服务器。组件的渲染效果与生产环境一致。
前置条件
- Node.js 22.18+ 或 24.11+ - 使用
node --version检查 - 一个文档项目 - 包含
docs.json配置文件
启动开发服务器
全局安装 CLI,然后在文档目录中运行:
npm install -g jamdesk
cd your-docs
jamdesk dev您的文档将在 http://localhost:3000 上可用
可用功能
自定义端口
默认端口为 3000。使用 --port 指定其他端口:
jamdesk dev --port 3001
或在 ~/.jamdeskrc 中设置永久默认值:
{
"defaultPort": 3001
}
详细模式
使用 --verbose 标志显示构建详情:
jamdesk dev --verbose
这将显示:
- 文件变更检测
- 构建耗时
- 导航解析
- 任何警告或错误
首次运行性能
首次运行 jamdesk dev 时会将依赖安装到 ~/.jamdesk,耗时 30–60 秒。之后的运行将在 5 秒内启动。
清除缓存并强制重新安装:
jamdesk clean
jamdesk dev
故障排除
另一个进程正在使用端口 3000。
方案一: 使用其他端口
jamdesk dev --port 3001方案二: 查找并停止该进程
lsof -i :3000
kill -9 <PID>请在包含 docs.json 文件的目录中运行该命令:
ls docs.json # Should show the file
jamdesk dev- 检查终端是否有错误
- 强制刷新浏览器(Cmd+Shift+R)
- 重启开发服务器
- 运行
jamdesk clean后重试
运行诊断:
jamdesk doctor它会检查您的环境并报告问题。
