fangtian-design-docs
v1.0.0
Published
方田设计组件库文档
Downloads
4
Maintainers
Readme
方田设计组件库文档
这是方田设计组件库的统一文档站点,整合了业务组件库(CBC-Vue)和通用组件库(Pro-Components)的文档。
目录结构
docs/
├── .vitepress/ # VitePress 配置
├── guide/ # 开发指南
│ ├── introduction.md # 介绍
│ └── getting-started.md # 快速开始
├── cbc-vue/ # 业务组件库文档
│ ├── quick-start.md # 快速上手
│ └── order-detail.md # 订单详情组件
├── pro-components/ # 通用组件库文档
│ └── index.md # 索引页
└── index.md # 首页开发
安装依赖
cd docs
pnpm install启动开发服务器
pnpm run dev构建文档
pnpm run build预览构建结果
pnpm run preview添加新组件文档
添加业务组件文档
- 在
docs/cbc-vue/目录下创建新的 Markdown 文件 - 在
.vitepress/config.ts的sidebar['cbc-vue']中添加新的导航项
添加通用组件文档
- 在
docs/pro-components/目录下创建新的 Markdown 文件 - 在
.vitepress/config.ts的sidebar['pro-components']中添加新的导航项
注意事项
- 文档使用 Markdown 格式编写
- 组件示例代码应该使用 ```vue 代码块
- 组件属性、事件、插槽等应该使用表格形式展示
- 文档中的图片应该放在
docs/public目录下
