开发指南

项目结构

• “/ui/lib”文件夹存放业务功能源码（组件、 工具函数、样式等）
• “/core” 文件夹 为 项目工程化的代码（各自配置、打包发布、工程化自定义插件等）
• “/docs” 文件夹：MyUI 文档文件
• “/src” 文件夹： MyUI 开发测试环境

组件开发过程

• 启动开发模式： npm run dev
• 在"/src"内 开发组件
• 常规组件开发完成后，在“/ui/lib/components”文件夹下 添加 “my-”为前缀的组件名称文件夹，例如： "/my-edit-filed", 文件夹内容可以参考其他组件， 并将组件 html / js 代码放置于内，并编写安装函数（参考其他组件）
• （重点）将常规组件的样式添加到“/ui/lib/styles”下面，添加与组件同名文件，如“my-edit-filed.scss”。如果组件无需样式，也要创建一个同名空文件（切记）。
• 其他类型组件（如 echart / gojs / 地图）可放置于对应目录下，各自目录有对应的styles文件夹。

组件文档编写

组件文档位于 /docs 文件夹

• 编辑文档通过 “npm run dev:docs” 进行启动， 系统会打开.vuepress 的项目
• 组件的基本文档： 在开发一个组件的过程中，需要按照规范书写组件的 属性 、 插槽 和 函数 的注释（参考已有组件）。vuepress 可以自动生成组件文档。
• 组件的使用文档：在"/docs/ui"文件夹下，已经分类放置不同类型的组件文档。请在你组件关联的类型文件夹内创建 对应的 md文件。
• 组件使用文档的编写参考已有文档。
• 配置文档的导航： 文档的导航配置文件位于“/docs/.vuepress/nav.js 、sidebar.js”