From 0c9e8da6c3cc688388443b4808e43f1a154472f3 Mon Sep 17 00:00:00 2001 From: neverland Date: Mon, 29 Nov 2021 17:37:34 +0800 Subject: [PATCH] docs: update repo struct (#9956) * docs: update repo struct * docs: update * docs: update * docs: update --- .../vant/docs/markdown/contribution.zh-CN.md | 31 ++++++++++++------- 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/packages/vant/docs/markdown/contribution.zh-CN.md b/packages/vant/docs/markdown/contribution.zh-CN.md index a093675e1..86782581e 100644 --- a/packages/vant/docs/markdown/contribution.zh-CN.md +++ b/packages/vant/docs/markdown/contribution.zh-CN.md @@ -34,29 +34,36 @@ pnpm dev ### 目录结构 -项目的主要目录结构如下所示： +Vant 采用 monorepo 进行代码管理，所有子包在 `packages` 目录下: + +``` +root +└─ packages + ├─ vant # 组件库 + ├─ vant-cli # 脚手架 + ├─ vant-icons # 图标库 + ├─ vant-use # Composition API + └─ .... # 其他周边 npm 包 +``` + +其中，`vant` 目录为组件库的核心代码： ``` vant -├─ docs # 文档 -├─ packages # 基础包 -├─ src # 组件源代码 -├─ test # 单测工具类 -└─ vant.config.mjs # 文档网站配置 +├─ docs # 文档 +├─ src # 组件源代码 +├─ test # 单测工具类 +└─ vant.config.mjs # 文档网站配置 ``` -组件代码位于 src 目录下，每个组件一个独立的文件夹。 - -### 组件目录结构 - -添加新组件时，请按照下面的目录结构组织文件，并在 `vant.config.mjs` 中配置组件名称。 +`src` 目录包含各个组件的源码，每个文件夹对应一个组件： ``` src └─ button ├─ demo # 示例代码 ├─ test # 单元测试 - ├─ Component.ts # 组件 + ├─ Component.tsx # 组件 ├─ index.ts # 组件入口 ├─ index.less # 样式 ├─ var.less # 样式变量