MarvelCode 组件资产模版库

目录结构

├───tsconfig.json														# Typescript配置文件
├───vite.config.docs.ts											# 文档的构建配置文件
├───vite.config.package.ts									# 组件库或单组件的构建配置文件
├───Shell                     	            # shell命令文件夹
│	├── deploy.sh                             # 部署命令
│	├── publish.sh                            # 组件发布命令
├───Src																			# 工程核心文件夹
│   ├── docs                	              # 文档文件夹
│   ├── packages                            # 组件库核心文件夹
│   │   │─── core                           # 组件核心代码
│   │   │    │─── xxxxx                     # 组件文件夹 例如：button或card
|   |   |    |     │─── examples         		# 示例文件夹
|   |   |    |     |	  |-- xxxx           	# 详细示例文件夹 例如: button-base
|   |   |    |     |    |	  |-- docs.md     # 示例文档描述文件
|   |   |    |     |    |	  |-- index.vue   # 示范核心编码文件
|   |   |    |     │─── index.ts         		# 对外暴露组件信息文件
|   |   |    |     │─── index.vue         	# 组件核心编码文件
|   |   |    |     │─── README.md         	# 组件基础文档编写文件
│   │   │─── styles                         # 样式表文件夹
│   │   │    │─── variables.scss            # 变量定义文件
│   │   │─── index.ts                       # 对外暴露组件库文件

工程命令描述

| 命令 | 描述 | | -------------- | -------------------------- | | serve:docs | 启动文档查看的本地开发命令 | | build:docs | 打包文档的命令 | | preview:docs | 启动文档的本地静态服务 | | build:packages | 打包组件库的命令 | | build | 同时打包组件库及文档 | | rl | 发布组件库命令 | | deploy | 部署&上传代码命令 |

特殊说明

• 无需自己搭建文档的平台，按照工程的文件结构编写示例以及文档就会自动生成文档页面
• 工程默认使用了Sass样式预处理器，如有其他需要请自行配置