主题
中保智慧综合服务平台 · 前端文档库
本文档库记录中保智慧综合服务平台(manage-web)前端各业务模块的页面说明,供产品、开发与测试参考。左侧栏即平台完整菜单树,按菜单层级组织。
文档结构
- 文档目录按菜单树组织在
projects/smart-platform/menus/下,可任意层级嵌套。 - 左侧栏由
.vitepress/sidebar.mjs递归扫描menus/自动生成,默认收起,并自动展开当前页面所在的层级。 - 每个菜单节点对应一个
index.md,标题为菜单中文名。
菜单数据来源
菜单结构以后端返回的菜单 JSON 为准,完整数据存于 scripts/menu-data.json(字段:id / parentId / seq / name / url / childMenus,最深 6 级,共 16 个一级菜单)。前端文档只跟随菜单,不自行定义结构。
如何维护
填充页面内容
- 在左侧栏定位菜单,或按菜单路径找到
projects/smart-platform/menus/.../index.md。 - 参考已完成的范本(如 业务数据明细)填写:基础信息、页面功能、使用组件、使用 Store、调用接口。
- 接口路径记录业务简写即可,实际请求统一带
/api前缀(如home/xxx→/api/home/xxx)。 - 页面源码在
manage-web仓库(Vue2 + element-ui,部分页面用<script setup>)。本机克隆路径记录在scripts/frontend-path.local.json(每人不同,已 gitignore;模板见frontend-path.local.example.json)。
菜单变动(新增 / 调整结构)
菜单来自后端,如菜单结构有变化:
- 更新
scripts/menu-data.json。 - 执行
node scripts/scaffold-menus.mjs --apply自动补建缺失的占位页(已存在的不会覆盖)。 - 执行
node scripts/build-sidebar.mjs重建侧栏。
排序
每个 index.md 用 frontmatter seq 对齐菜单顺序:
md
---
seq: 1
---无 seq 的项按标题字母序排在后面。
本地预览与构建
bash
corepack pnpm docs:dev # 本地开发,访问 http://localhost:5173
corepack pnpm docs:build # 构建到 .vitepress/distdocs:dev / docs:build 的前置步骤会自动重建侧栏 JSON;修改 .vitepress/config.mjs(如顶部导航)需重启 dev 才生效。
外部系统页面
部分菜单项(如「数字经营平台」)是跳转到独立部署的外部系统(window.open 携 token 单点登录),不在 manage-web 仓库内,其文档由对应系统仓库维护,本文档库只保留入口说明。
修改记录
| 修改人 | 修改时间 | 修改内容 |
|---|---|---|
| zhouw | 2026-07-03 | 编写页面内容 |