Skip to content

本地开发 ​

线上地址:https://xincodingbreeze.github.io/scene-mapping-docs/

安装依赖 ​

bash
npm install

常用命令 ​

命令用途
npm run dev启动总 Demo,兼容已有使用方式
npm run docs:dev启动 VitePress 文档站
npm run docs:build静态构建文档
npm run docs:preview预览文档构建产物
npm run docs:deploy构建并发布到 GitHub Pages
npm run typecheckVue 与 TypeScript 类型检查
npm run build构建 npm 组件库

文档目录 ​

text
docs/
├─ .vitepress/
│  ├─ theme/           # 主题扩展与视觉样式
│  └─ config.mts       # 导航、侧边栏和 Vite 配置
├─ 2d/
│  ├─ components/      # 2D 文档实时 Vue 示例
│  └─ docs/            # 2D Markdown,一个组件一篇
├─ 3d/
│  ├─ components/      # 3D 文档实时 Vue 示例
│  └─ docs/            # 3D Markdown,按使用任务组织
├─ guide/              # 使用与工程指南
├─ common/             # 2D/3D 统一场景文档
├─ reference/          # 类型参考
└─ index.md             # 文档首页

编写可运行示例 ​

Leaflet 只能在浏览器运行。文档示例先渲染占位容器,再在 onMounted 后加载 *Inner.vue,避免 SSR 阶段执行地图代码。

文档通过 @scene-2d 和 @scene-3d 直接引用源码,示例会反映当前改动。后续 2D/3D 示例优先放在 docs,总 Demo 继续保留。

发布前检查 ​

bash
npm run typecheck
npm run docs:build
npm run build

不要把天地图 Key、Cesium Token 或业务接口凭证写进 Markdown、示例组件和提交记录。