# 开发指南

组件库源码 (opens new window)

组件库文档源码 (opens new window)

组件库示例 (opens new window)

NPM源 (opens new window)

淘宝源 (opens new window)

# 参与开发

# 【组件库】本地开发

# 克隆仓库
`git clone git@git.tz.com:webfront/npmpackages/element-ui-best.git`

# 安装依赖
cd element-ui-best && npm install

# 进入开发模式,浏览器访问 http://localhost:8081 
npm run dev

# 目录结构

  • packages 组件代码目录
  • examples 组件示例目录
  • lib 组件库最终打包的目录
  • public 项目静态资源目录

# 组件开发规范

  • 在packages目录下新增组件,在examples目录创建组件示例
  • 在element-ui-best-doc中创建组件文档

# 代码规范

遵循前端的ESLint即可

# 打包

# 打包组件库
npm run build:lib

# 打包示例
npm run build:example

# 【组件库文档】本地开发

组件库文档基于vuepress@1.x开发

# 克隆仓库
`git clone git@git.tz.com:webfront/npmpackages/element-ui-best-doc.git`

# 安装依赖
cd element-ui-best-doc && npm install

# 进入开发模式,浏览器访问 http://localhost:8081/element-ui-best-doc/
npm run dev:docs

# 打包

## 打包文档
npm run build:docs