From 279ce30cbf266ed894065a04127fa68ac98513a6 Mon Sep 17 00:00:00 2001 From: chufan Date: Thu, 29 Aug 2024 15:01:33 +0800 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20=E5=90=84=E6=A8=A1=E5=9D=97`README`?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E5=A2=9E=E5=8A=A0=E7=89=88=E6=9C=AC=E6=A0=87?= =?UTF-8?q?=E8=AE=B0=EF=BC=8C=E4=BC=98=E5=8C=96=E9=9D=99=E6=80=81=E7=AB=99?= =?UTF-8?q?=E7=82=B9=E5=86=85=E5=AE=B9=E6=98=BE=E7=A4=BA?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .vitepress/config.ts | 14 +-- .vitepress/theme/components/ContactAuthor.vue | 30 +++--- .vitepress/theme/components/HomePage.vue | 94 +++++++++++++++++++ .vitepress/theme/components/TeamMembers.ts | 43 --------- .vitepress/theme/components/index.ts | 1 - docs/index.md | 72 ++------------ packages/axios/README.md | 2 + packages/egg-axios/README.md | 2 + packages/egg-grpc-client/README.md | 2 + packages/egg-grpc-server/README.md | 2 + packages/egg-mysql/README.md | 2 + packages/egg-redis/README.md | 2 + packages/egg-sequelize/README.md | 2 + packages/egg-swagger/README.md | 2 + packages/egg/README.md | 2 + packages/eslint-config/README.md | 2 + packages/fairy-cli/README.md | 2 + packages/nest-redis/README.md | 2 + packages/nest-typeorm/README.md | 2 + packages/nest/README.md | 2 + packages/oauth/README.md | 4 +- packages/release-version/README.md | 2 + packages/typeorm/README.md | 12 +++ packages/vitepress/README.md | 2 + packages/vuepress/README.md | 12 +++ 25 files changed, 178 insertions(+), 136 deletions(-) create mode 100644 .vitepress/theme/components/HomePage.vue delete mode 100644 .vitepress/theme/components/TeamMembers.ts delete mode 100644 .vitepress/theme/components/index.ts diff --git a/.vitepress/config.ts b/.vitepress/config.ts index eb3d9a1..1fe7d18 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -16,8 +16,8 @@ const GithubLinks = { * 页脚 */ export const footer = { - message: `Released Under The License MIT `, - copyright: `Copyright © 2019-present 142vip 👉储凡`, + message: `The License 📖 MIT `, + copyright: `Release ${packageName}@${currentPackageVersion} 😏
Copyright © 2019-present. Repo @142vip Author. 👉储凡`, } /** @@ -29,8 +29,8 @@ export const navbarConfig: DefaultTheme.NavItem[] = [ link: '/docs/index.md', }, { - text: '开发计划', - link: '/docs/road-map.md', + text: '自媒体', + link: '/docs/media.md', }, { text: currentPackageVersion, @@ -46,8 +46,8 @@ export const navbarConfig: DefaultTheme.NavItem[] = [ ], }, { - text: '自媒体', - link: '/docs/media.md', + text: '开发计划', + link: 'https://142vip-cn.feishu.cn/share/base/view/shrcnpwFKWmMu5zXE9WaxjuCYAg', }, ] @@ -70,7 +70,7 @@ const sidebarConfig: DefaultTheme.Sidebar = [ { text: '@142vip/axios', link: '/packages/axios' }, { text: '@142vip/oauth', link: '/packages/oauth' }, { text: '@142vip/redis', link: '/packages/redis' }, - { text: '@142vip/typeorm', link: '/packages/redis' }, + { text: '@142vip/typeorm', link: '/packages/typeorm' }, ], }, { diff --git a/.vitepress/theme/components/ContactAuthor.vue b/.vitepress/theme/components/ContactAuthor.vue index 5ab63ec..5e288d0 100644 --- a/.vitepress/theme/components/ContactAuthor.vue +++ b/.vitepress/theme/components/ContactAuthor.vue @@ -1,13 +1,12 @@ - @@ -89,6 +80,7 @@ justify-content: center; align-items: center; padding: 5px; + margin-bottom: 10px; } .platform-img { diff --git a/.vitepress/theme/components/HomePage.vue b/.vitepress/theme/components/HomePage.vue new file mode 100644 index 0000000..7988445 --- /dev/null +++ b/.vitepress/theme/components/HomePage.vue @@ -0,0 +1,94 @@ + + + + + diff --git a/.vitepress/theme/components/TeamMembers.ts b/.vitepress/theme/components/TeamMembers.ts deleted file mode 100644 index bbefc7c..0000000 --- a/.vitepress/theme/components/TeamMembers.ts +++ /dev/null @@ -1,43 +0,0 @@ -/** - * 团队成员 - */ -export const teamMembers = [ - { - avatar: 'https://www.github.com/142vip.png', - name: '142vip', - title: '开源组织', - links: [ - { icon: 'github', link: 'https://github.com/mmdapl' }, - ], - }, - { - avatar: 'https://www.github.com/mmdapl.png', - name: '储凡', - title: 'Creator', - org: '142vip', - orgLink: 'https://github.com/142vip', - links: [ - { icon: 'github', link: 'https://github.com/mmdapl' }, - ], - }, - { - avatar: 'https://www.github.com/chufan443.png', - name: '微信公众号：储凡', - title: 'CodeReviewer', - org: '142vip', - orgLink: 'https://github.com/142vip', - links: [ - { icon: 'github', link: 'https://github.com/chufan443' }, - ], - }, - { - avatar: 'https://www.github.com/lir0115.png', - name: '公众号：Rong姐姐好可爱', - title: 'Committer', - org: '142vip', - orgLink: 'https://github.com/142vip', - links: [ - { icon: 'github', link: 'https://github.com/lir0115' }, - ], - }, -] diff --git a/.vitepress/theme/components/index.ts b/.vitepress/theme/components/index.ts deleted file mode 100644 index 01ee0f5..0000000 --- a/.vitepress/theme/components/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './TeamMembers' diff --git a/docs/index.md b/docs/index.md index 0e97c40..03f63aa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,11 +7,14 @@ hero: tagline: "易学易用、性能出色，适用工程化的通用工具包" actions: - theme: brand - text: 快速上手 → + text: 快速开始 🚀 link: /packages/fairy-cli - theme: alt - text: 408CSFamily + text: 🤡 408CSFamily link: https://github.com/142vip/408CSFamily + - theme: alt + text: 📘 JavaScriptCollection + link: https://github.com/142vip/JavaScriptCollection # 功能页 features: - title: 易学易用 @@ -25,68 +28,7 @@ features: --- -## @142vip/core-x - -### 贡献 - - - -## 赞赏列表 - -以下排名不分先后， **赞赏过的一定要微信跟我说呀！！！！！！** - -
- - ChiefPing - - - xiaoliuxin - -
- -## 赞助商 - -以下排名不分先后! 还木有收到赞助，哈哈哈，先留坑 - -## 贡献 - -> 感谢所有参与仓库建设的开发者 - - - 感谢向仓库提交PR的所有开发者 - - -## 趋势 - -
- Star History -
- - - - + diff --git a/packages/axios/README.md b/packages/axios/README.md index 638b900..bf6ca2d 100644 --- a/packages/axios/README.md +++ b/packages/axios/README.md @@ -1,5 +1,7 @@ # @142vip/axios +[![NPM version](https://img.shields.io/npm/v/@142vip/axios?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/axios) + ## 参考 - [axios](https://github.com/axios/axios) diff --git a/packages/egg-axios/README.md b/packages/egg-axios/README.md index e83d769..ba24ebd 100644 --- a/packages/egg-axios/README.md +++ b/packages/egg-axios/README.md @@ -1,5 +1,7 @@ # @142vip/egg-axios +[![NPM version](https://img.shields.io/npm/v/@142vip/egg-axios?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/egg-axios) + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/egg-grpc-client/README.md b/packages/egg-grpc-client/README.md index c180670..05afbda 100644 --- a/packages/egg-grpc-client/README.md +++ b/packages/egg-grpc-client/README.md @@ -1,5 +1,7 @@ # @142vip/egg-grpc-client +[![NPM version](https://img.shields.io/npm/v/@142vip/egg-grpc-client?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/egg-grpc-client) + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/egg-grpc-server/README.md b/packages/egg-grpc-server/README.md index 2326b8d..284f3e0 100644 --- a/packages/egg-grpc-server/README.md +++ b/packages/egg-grpc-server/README.md @@ -1,5 +1,7 @@ # @142vip/egg-grpc-server +[![NPM version](https://img.shields.io/npm/v/@142vip/egg-grpc-server?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/egg-grpc-server) + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/egg-mysql/README.md b/packages/egg-mysql/README.md index bce04b4..4959a18 100644 --- a/packages/egg-mysql/README.md +++ b/packages/egg-mysql/README.md @@ -1,5 +1,7 @@ # @142vip/egg-mysql +[![NPM version](https://img.shields.io/npm/v/@142vip/egg-mysql?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/egg-mysql) + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/egg-redis/README.md b/packages/egg-redis/README.md index 7afcf51..fae0433 100644 --- a/packages/egg-redis/README.md +++ b/packages/egg-redis/README.md @@ -1,5 +1,7 @@ # @142vip/egg +[![NPM version](https://img.shields.io/npm/v/@142vip/egg?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/egg) + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/egg-sequelize/README.md b/packages/egg-sequelize/README.md index 7fb57af..5f3d098 100644 --- a/packages/egg-sequelize/README.md +++ b/packages/egg-sequelize/README.md @@ -1,5 +1,7 @@ # @142vip/egg-sequelize +[![NPM version](https://img.shields.io/npm/v/@142vip/egg-sequelize?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/egg-sequelize) + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/egg-swagger/README.md b/packages/egg-swagger/README.md index 2acebff..5feeee8 100644 --- a/packages/egg-swagger/README.md +++ b/packages/egg-swagger/README.md @@ -1,5 +1,7 @@ # @142vip/egg-swagger +[![NPM version](https://img.shields.io/npm/v/@142vip/egg-swagger?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/egg-swagger) + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/egg/README.md b/packages/egg/README.md index 7afcf51..fae0433 100644 --- a/packages/egg/README.md +++ b/packages/egg/README.md @@ -1,5 +1,7 @@ # @142vip/egg +[![NPM version](https://img.shields.io/npm/v/@142vip/egg?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/egg) + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md index 418d7c0..f384202 100644 --- a/packages/eslint-config/README.md +++ b/packages/eslint-config/README.md @@ -1,5 +1,7 @@ # @142vip/eslint-config +[![NPM version](https://img.shields.io/npm/v/@142vip/eslint-config?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/eslint-config) + ## 参考 - diff --git a/packages/fairy-cli/README.md b/packages/fairy-cli/README.md index b1b2404..0148e04 100644 --- a/packages/fairy-cli/README.md +++ b/packages/fairy-cli/README.md @@ -1,5 +1,7 @@ # @142vip/fairy-cli +[![NPM version](https://img.shields.io/npm/v/@142vip/fairy-cli?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/fairy-cli) + `@142vip/fairy-cli`是一个工程化项目CLI工具，在终端中可以使用别名`fa`执行命令。 ## 快速使用 diff --git a/packages/nest-redis/README.md b/packages/nest-redis/README.md index 977bbe7..4cad2f0 100644 --- a/packages/nest-redis/README.md +++ b/packages/nest-redis/README.md @@ -1,5 +1,7 @@ # @142vip/nest-redis +[![NPM version](https://img.shields.io/npm/v/@142vip/nest-redis?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/nest-redis) + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/nest-typeorm/README.md b/packages/nest-typeorm/README.md index 977bbe7..9507d5f 100644 --- a/packages/nest-typeorm/README.md +++ b/packages/nest-typeorm/README.md @@ -1,5 +1,7 @@ # @142vip/nest-redis +[![NPM version](https://img.shields.io/npm/v/@142vip/nest-typeorm?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/nest-typeorm) + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/nest/README.md b/packages/nest/README.md index 70b9cb6..a66cc6d 100644 --- a/packages/nest/README.md +++ b/packages/nest/README.md @@ -1,5 +1,7 @@ # @142vip/nest +[![NPM version](https://img.shields.io/npm/v/@142vip/nest?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/nest) + ## 参考资料 - 官方文档： diff --git a/packages/oauth/README.md b/packages/oauth/README.md index 78b80fb..6a07703 100644 --- a/packages/oauth/README.md +++ b/packages/oauth/README.md @@ -1,4 +1,6 @@ -# @142vip/redis +# @142vip/oauth + +[![NPM version](https://img.shields.io/npm/v/@142vip/oauth?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/oauth) ## 证书 diff --git a/packages/release-version/README.md b/packages/release-version/README.md index cbeb530..5d6af9f 100644 --- a/packages/release-version/README.md +++ b/packages/release-version/README.md @@ -1,5 +1,7 @@ # @142vip/release-version +[![NPM version](https://img.shields.io/npm/v/@142vip/release-version?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/release-version) + ## 使用 ```shell diff --git a/packages/typeorm/README.md b/packages/typeorm/README.md index f54c428..ad152a5 100644 --- a/packages/typeorm/README.md +++ b/packages/typeorm/README.md @@ -1,5 +1,17 @@ # @142vip/typeorm +[![NPM version](https://img.shields.io/npm/v/@142vip/typeorm?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/typeorm) + +## 使用 + +```shell +# 安装 +pnpm i @142vip/typeorm + +# 安装typeorm +pnpm i typeorm +``` + ## 证书 [MIT](https://opensource.org/license/MIT) diff --git a/packages/vitepress/README.md b/packages/vitepress/README.md index cc74b58..960745b 100644 --- a/packages/vitepress/README.md +++ b/packages/vitepress/README.md @@ -1,5 +1,7 @@ # @142vip/vitepress +[![NPM version](https://img.shields.io/npm/v/@142vip/vitepress?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/vitepress) + ## 使用 ```shell diff --git a/packages/vuepress/README.md b/packages/vuepress/README.md index 6e85750..8b336f9 100644 --- a/packages/vuepress/README.md +++ b/packages/vuepress/README.md @@ -1,5 +1,17 @@ # @142vip/vuepress +[![NPM version](https://img.shields.io/npm/v/@142vip/vuepress?color=a1b858&label=version)](https://www.npmjs.com/package/@142vip/vuepress) + +## 使用 + +```shell +# 安装 +pnpm i @142vip/vuepress -D + +# 安装vuepress +pnpm i vuepress -D +``` + ## 证书 [MIT](https://opensource.org/license/MIT) From b91733ada46977a9b1f478097fd1616b291f1743 Mon Sep 17 00:00:00 2001 From: chufan Date: Thu, 29 Aug 2024 15:12:28 +0800 Subject: [PATCH 2/2] =?UTF-8?q?fix(Github=20Actions):=20=E4=BF=AE=E5=A4=8D?= =?UTF-8?q?=E6=B5=81=E6=B0=B4=E7=BA=BFbuild=E5=BC=82=E5=B8=B8=EF=BC=8C?= =?UTF-8?q?=E5=85=88=E7=BC=96=E8=AF=91=E5=85=AC=E5=85=B1=E6=A8=A1=E5=9D=97?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/CD.yaml | 3 ++- .github/workflows/CI.yml | 9 +++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/CD.yaml b/.github/workflows/CD.yaml index 4385295..f2a95df 100644 --- a/.github/workflows/CD.yaml +++ b/.github/workflows/CD.yaml @@ -160,7 +160,8 @@ jobs: # 编译 打包成dist - name: Build with VitePress - run: pnpm build:docs + run: | + pnpm build && pnpm build:docs # 上传dist文件 - name: Upload artifact diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 90709e8..9877df6 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -59,11 +59,12 @@ jobs: run: | npx eslint . + # 编辑模块代码 + - name: Build Package Code + run: | + pnpm build + # 编译静态网站 - name: Build Core-X Docs run: | pnpm build:docs - - - name: Build Code - run: | - pnpm build