Skip to content

Commit 0184bc8

Browse files
committed
docs(mono): 补充开发日志(changelog-needed)
affects: @ued-plus/components ISSUES CLOSED: none
1 parent c74a261 commit 0184bc8

File tree

7 files changed

+70
-83
lines changed

7 files changed

+70
-83
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
### 自定义组件库(Vue3)
22

33
- 参考:https://juejin.cn/column/7118932817119019015
4+
- 参考:https://github.com/bin-K/monorepo-pnpm-vue#monorepo-pnpm-%E6%A8%A1%E5%BC%8F%E7%AE%A1%E7%90%86%E5%A4%9A%E4%B8%AA-web-%E9%A1%B9%E7%9B%AEvue3
45

56
#### 组件库的环境配置
67

@@ -664,7 +665,9 @@ export default {
664665
{ text: '指南', link: '/guide/installation/' },
665666
{ text: '组件', link: '/components/button/' },
666667
],
667-
socialLinks: [{ icon: 'github', link: 'https://github.com/bin-K/ued-plus' }],
668+
socialLinks: [
669+
{ icon: 'github', link: 'https://github.com/bin-K/ued-plus' },
670+
],
668671
},
669672
}
670673
```

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
#### 初始化monorepo项目
44

5-
- 参考:https://github.com/bin-K/monorepo-pnpm-vue
5+
- 参考:https://github.com/bin-K/monorepo-pnpm-vue#monorepo-pnpm-%E6%A8%A1%E5%BC%8F%E7%AE%A1%E7%90%86%E5%A4%9A%E4%B8%AA-web-%E9%A1%B9%E7%9B%AEvue3
66

77
#### 组件库文档
88

devlogs/mono.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# 项目结构
2+
3+
```
4+
ued-plus
5+
├── CONTRIBUTING.md // 搭建教程
6+
├── README.md
7+
├── changelogs // 更新日志
8+
├── commitlint.config.cjs // commitizen 配置文件,git 提交时做限制,不允许随意提交信息
9+
├── devlogs // 开发思路记录
10+
├── package.json
11+
├── packages // 组件核心代码
12+
│ ├── components // 组件
13+
│ │ ├── components.ts // 暴露所有组件文件
14+
│ │ ├── index.ts // 全局入口文件
15+
│ │ ├── package.json
16+
│ │ ├── script // 打包组件需要的文件
17+
│ │ │ ├── build // 打包组件流程入口
18+
│ │ │ └── utils // 打包组件工具
19+
│ │ ├── src // 组件开发文件夹
20+
│ │ ├── vite.config.ts // vue 配置文件
21+
│ ├── hooks // 组件提取的公共钩子
22+
│ ├── theme // 组件公共样式和主题样式
23+
│ └── utils // 组件提取的公共工具
24+
├── play // 组件调试,一个vue项目
25+
├── pnpm-workspace.yaml // 配置工作区文件
26+
├── scripts // 初始化时执行的脚本已经打Tag需要生成日志的脚本
27+
│ ├── changelog // 日志生成的配置的文件
28+
│ │ ├── changelog-option.cjs
29+
│ │ └── cz-lerna-changelog.cjs
30+
│ └── shell // git flow 初始化和打tag回调的脚本
31+
│ ├── filter-flow-hotfix-finish-tag-message.sh
32+
│ ├── filter-flow-release-finish-tag-message.sh
33+
│ └── init.sh
34+
├── site // 组件文档
35+
│ ├── deploy.sh // 文档部署脚本
36+
│ ├── docs // 文档内容
37+
│ │ ├── changelogs // 日志
38+
│ │ ├── components // 组件文档
39+
│ │ ├── guide // 指南
40+
│ │ │ ├── installation // 安装
41+
│ │ │ └── quickstart // 快速开始
42+
│ │ ├── index.md
43+
│ │ └── public
44+
│ │ └── favicon.svg
45+
│ └── package.json
46+
└── tsconfig.json // ts配置文件
47+
```

packages/components/vite.config.ts.timestamp-1716788465744-07cb676a445ec.mjs

Lines changed: 0 additions & 81 deletions
This file was deleted.

site/docs/.vitepress/config.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ export default {
1717
level: 'deep',
1818
},
1919
nav: [
20+
{ text: '开发日志', link: '/devlogs/mono/' },
2021
{ text: '更新日志', link: '/changelogs/mono/' },
2122
{ text: '指南', link: '/guide/quickstart/' },
2223
{ text: '组件', link: '/components/button/' },
@@ -25,6 +26,21 @@ export default {
2526
{ icon: 'github', link: 'https://github.com/bin-K/ued-plus' },
2627
],
2728
sidebar: {
29+
'/devlogs': [
30+
{
31+
text: '基础日志',
32+
items: [
33+
{
34+
text: 'Project',
35+
link: '/devlogs/mono/project.md',
36+
},
37+
{
38+
text: 'Mono',
39+
link: '/devlogs/mono/',
40+
},
41+
],
42+
},
43+
],
2844
'/changelogs': [
2945
{
3046
text: '基础日志',

site/docs/devlogs/mono/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!--@include: ../../../../devlogs/mono.md-->

site/docs/devlogs/mono/project.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!--@include: ../../../../CONTRIBUTING.md-->

0 commit comments

Comments
 (0)