blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

docs: update repo struct (#9956)

Browse Source 
* docs: update repo struct

* docs: update

* docs: update

* docs: update
This commit is contained in:
neverland 2021-11-29 17:37:34 +08:00 committed by GitHub
parent 66e39af9e3
commit 0c9e8da6c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
packages/vant/docs/markdown/contribution.zh-CN.md
View File

@ -34,29 +34,36 @@ pnpm dev
### 目录结构 ### 目录结构
项目的主要目录结构如下所示： Vant 采用 monorepo 进行代码管理，所有子包在 `packages` 目录下:
```
root
└─ packages
├─ vant # 组件库
├─ vant-cli # 脚手架
├─ vant-icons # 图标库
├─ vant-use # Composition API
└─ .... # 其他周边 npm 包
```
其中，`vant` 目录为组件库的核心代码：
``` ```
vant vant
├─ docs # 文档 ├─ docs # 文档
├─ packages # 基础包
├─ src # 组件源代码 ├─ src # 组件源代码
├─ test # 单测工具类 ├─ test # 单测工具类
└─ vant.config.mjs # 文档网站配置 └─ vant.config.mjs # 文档网站配置
``` ```
组件代码位于 src 目录下，每个组件一个独立的文件夹。 `src` 目录包含各个组件的源码，每个文件夹对应一个组件：
### 组件目录结构
添加新组件时，请按照下面的目录结构组织文件，并在 `vant.config.mjs` 中配置组件名称。
``` ```
src src
└─ button └─ button
├─ demo # 示例代码 ├─ demo # 示例代码
├─ test # 单元测试 ├─ test # 单元测试
├─ Component.ts # 组件 ├─ Component.tsx # 组件
├─ index.ts # 组件入口 ├─ index.ts # 组件入口
├─ index.less # 样式 ├─ index.less # 样式
├─ var.less # 样式变量 ├─ var.less # 样式变量