chore: Rename the website directory to docs

vbenjs · Aug 1, 2024 · 06ad5ad · 06ad5ad
1 parent 4a7a4f9
commit 06ad5ad
Show file tree

Hide file tree

Showing 73 changed files with 154 additions and 374 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -65,10 +65,10 @@ jobs:
           password: ${{ secrets.WEB_ELE_FTP_PASSWORD }}
           local-dir: ./apps/web-ele/dist/
 
-      - name: Sync Website files
+      - name: Sync Docs files
         uses: SamKirkland/FTP-Deploy-Action@v4.3.5
         with:
           server: ${{ secrets.PRO_FTP_HOST }}
           username: ${{ secrets.WEBSITE_FTP_ACCOUNT }}
           password: ${{ secrets.WEBSITE_FTP_PASSWORD }}
-          local-dir: ./website/.vitepress/dist/
+          local-dir: ./docs/.vitepress/dist/
diff --git a/website/.vitepress/config.mts → docs/.vitepress/config.mts b/website/.vitepress/config.mts → docs/.vitepress/config.mts
@@ -212,7 +212,7 @@ function nav(): DefaultTheme.NavItem[] {
     },
     {
       link: '/commercial/community',
-      text: '👨‍👦‍👦 社区',
+      text: '👨‍👦‍👦 社区交流',
       // items: [
       //   {
       //     link: 'https://qun.qq.com/qqweb/qunpro/share?_wv=3&_wwv=128&appChannel=share&inviteCode=22ySzj7pKiw&businessType=9&from=246610&biz=ka&mainSourceId=share&subSourceId=others&jumpsource=shorturl#/pc',

diff --git a/...itepress/theme/components/site-layout.vue → ...itepress/theme/components/site-layout.vue b/...itepress/theme/components/site-layout.vue → ...itepress/theme/components/site-layout.vue
diff --git a/...ss/theme/components/vben-contributors.vue → ...ss/theme/components/vben-contributors.vue b/...ss/theme/components/vben-contributors.vue → ...ss/theme/components/vben-contributors.vue
diff --git a/website/.vitepress/theme/index.ts → docs/.vitepress/theme/index.ts b/website/.vitepress/theme/index.ts → docs/.vitepress/theme/index.ts
diff --git a/website/.vitepress/theme/plugins/hm.ts → docs/.vitepress/theme/plugins/hm.ts b/website/.vitepress/theme/plugins/hm.ts → docs/.vitepress/theme/plugins/hm.ts
diff --git a/website/.vitepress/theme/styles/base.css → docs/.vitepress/theme/styles/base.css b/website/.vitepress/theme/styles/base.css → docs/.vitepress/theme/styles/base.css
diff --git a/website/.vitepress/theme/styles/index.ts → docs/.vitepress/theme/styles/index.ts b/website/.vitepress/theme/styles/index.ts → docs/.vitepress/theme/styles/index.ts
diff --git a/...ite/.vitepress/theme/styles/variables.css → docs/.vitepress/theme/styles/variables.css b/...ite/.vitepress/theme/styles/variables.css → docs/.vitepress/theme/styles/variables.css
diff --git a/website/package.json → docs/package.json b/website/package.json → docs/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@vben/website",
+  "name": "@vben/docs",
   "version": "5.0.0",
   "private": true,
   "scripts": {

diff --git a/website/src/commercial/community.md → docs/src/commercial/community.md b/website/src/commercial/community.md → docs/src/commercial/community.md
diff --git a/website/src/commercial/customized.md → docs/src/commercial/customized.md b/website/src/commercial/customized.md → docs/src/commercial/customized.md
diff --git a/website/src/commercial/technical-support.md → docs/src/commercial/technical-support.md b/website/src/commercial/technical-support.md → docs/src/commercial/technical-support.md
diff --git a/website/src/en/guide/index.md → docs/src/en/guide/index.md b/website/src/en/guide/index.md → docs/src/en/guide/index.md
diff --git a/website/src/en/index.md → docs/src/en/index.md b/website/src/en/index.md → docs/src/en/index.md
diff --git a/website/src/friend-links/index.md → docs/src/friend-links/index.md b/website/src/friend-links/index.md → docs/src/friend-links/index.md
diff --git a/website/src/guide/essentials/build.md → docs/src/guide/essentials/build.md b/website/src/guide/essentials/build.md → docs/src/guide/essentials/build.md
diff --git a/website/src/guide/essentials/concept.md → docs/src/guide/essentials/concept.md b/website/src/guide/essentials/concept.md → docs/src/guide/essentials/concept.md
diff --git a/website/src/guide/essentials/development.md → docs/src/guide/essentials/development.md b/website/src/guide/essentials/development.md → docs/src/guide/essentials/development.md
@@ -75,7 +75,7 @@ npm 脚本是项目常见的配置，用于执行一些常见的任务，比如
     // 启动web-antd应用
     "dev:antd": "pnpm -F @vben/web-antd run dev",
     // 启动文档
-    "dev:docs": "pnpm -F @vben/website run dev",
+    "dev:docs": "pnpm -F @vben/docs run dev",
     // 启动 element plus应用
     "dev:ele": "pnpm -F @vben/web-ele run dev",
     // 启动web-naive应用
@@ -135,7 +135,7 @@ pnpm dev:naive
 pnpm dev:ele
 ```
 
-运行 `website` 应用：
+运行 `docs` 应用：
 
 ```bash
 pnpm dev:docs

diff --git a/...e/src/guide/essentials/external-module.md → docs/src/guide/essentials/external-module.md b/...e/src/guide/essentials/external-module.md → docs/src/guide/essentials/external-module.md
diff --git a/website/src/guide/essentials/icons.md → docs/src/guide/essentials/icons.md b/website/src/guide/essentials/icons.md → docs/src/guide/essentials/icons.md
diff --git a/website/src/guide/essentials/route.md → docs/src/guide/essentials/route.md b/website/src/guide/essentials/route.md → docs/src/guide/essentials/route.md
diff --git a/website/src/guide/essentials/server.md → docs/src/guide/essentials/server.md b/website/src/guide/essentials/server.md → docs/src/guide/essentials/server.md
diff --git a/website/src/guide/essentials/settings.md → docs/src/guide/essentials/settings.md b/website/src/guide/essentials/settings.md → docs/src/guide/essentials/settings.md
diff --git a/website/src/guide/essentials/styles.md → docs/src/guide/essentials/styles.md b/website/src/guide/essentials/styles.md → docs/src/guide/essentials/styles.md
diff --git a/website/src/guide/in-depth/access.md → docs/src/guide/in-depth/access.md b/website/src/guide/in-depth/access.md → docs/src/guide/in-depth/access.md
diff --git a/website/src/guide/in-depth/check-updates.md → docs/src/guide/in-depth/check-updates.md b/website/src/guide/in-depth/check-updates.md → docs/src/guide/in-depth/check-updates.md
diff --git a/website/src/guide/in-depth/features.md → docs/src/guide/in-depth/features.md b/website/src/guide/in-depth/features.md → docs/src/guide/in-depth/features.md
diff --git a/website/src/guide/in-depth/layout.md → docs/src/guide/in-depth/layout.md b/website/src/guide/in-depth/layout.md → docs/src/guide/in-depth/layout.md
diff --git a/website/src/guide/in-depth/loading.md → docs/src/guide/in-depth/loading.md b/website/src/guide/in-depth/loading.md → docs/src/guide/in-depth/loading.md
diff --git a/website/src/guide/in-depth/locale.md → docs/src/guide/in-depth/locale.md b/website/src/guide/in-depth/locale.md → docs/src/guide/in-depth/locale.md
diff --git a/website/src/guide/in-depth/theme.md → docs/src/guide/in-depth/theme.md b/website/src/guide/in-depth/theme.md → docs/src/guide/in-depth/theme.md
diff --git a/website/src/guide/in-depth/ui-framework.md → docs/src/guide/in-depth/ui-framework.md b/website/src/guide/in-depth/ui-framework.md → docs/src/guide/in-depth/ui-framework.md
diff --git a/website/src/guide/introduction/changelog.md → docs/src/guide/introduction/changelog.md b/website/src/guide/introduction/changelog.md → docs/src/guide/introduction/changelog.md
diff --git a/...ite/src/guide/introduction/quick-start.md → docs/src/guide/introduction/quick-start.md b/...ite/src/guide/introduction/quick-start.md → docs/src/guide/introduction/quick-start.md
diff --git a/website/src/guide/introduction/roadmap.md → docs/src/guide/introduction/roadmap.md b/website/src/guide/introduction/roadmap.md → docs/src/guide/introduction/roadmap.md
diff --git a/website/src/guide/introduction/vben.md → docs/src/guide/introduction/vben.md b/website/src/guide/introduction/vben.md → docs/src/guide/introduction/vben.md
@@ -1,9 +1,9 @@
 # 关于 Vben Admin
 
-::: info 你正在阅读的是 [Vben Admin](https://github.com/vbenjs/vue-vben-admin) 的文档！
+::: info 你正在阅读的是 [Vben Admin](https://github.com/vbenjs/vue-vben-admin) `5.0`版本的文档！
 
 - Vben Admin 2.x 目前已经存档，只修复一些严重的问题。
-- 新版本与旧版本不兼容，如果你使用的是旧版本，请查看 [Vue Vben Admin 2.x 文档](https://doc.vvbin.cn)
+- 新版本与旧版本不兼容，如果你使用的是旧版本（v2、v3），请查看 [Vue Vben Admin 2.x 文档](https://doc.vvbin.cn)
 - 如发现文档有误，欢迎提提交 Issue 帮助我们改进。
 - 如果你只是想体验一下，你可以查看 [快速开始](./quick-start.md)。
 

diff --git a/website/src/guide/introduction/why.md → docs/src/guide/introduction/why.md b/website/src/guide/introduction/why.md → docs/src/guide/introduction/why.md
diff --git a/website/src/guide/other/faq.md → docs/src/guide/other/faq.md b/website/src/guide/other/faq.md → docs/src/guide/other/faq.md
diff --git a/website/src/guide/other/project-update.md → docs/src/guide/other/project-update.md b/website/src/guide/other/project-update.md → docs/src/guide/other/project-update.md
diff --git a/website/src/guide/other/remove-code.md → docs/src/guide/other/remove-code.md b/website/src/guide/other/remove-code.md → docs/src/guide/other/remove-code.md
diff --git a/website/src/guide/project/changeset.md → docs/src/guide/project/changeset.md b/website/src/guide/project/changeset.md → docs/src/guide/project/changeset.md
diff --git a/website/src/guide/project/cli.md → docs/src/guide/project/cli.md b/website/src/guide/project/cli.md → docs/src/guide/project/cli.md
diff --git a/website/src/guide/project/standard.md → docs/src/guide/project/standard.md b/website/src/guide/project/standard.md → docs/src/guide/project/standard.md
diff --git a/website/src/guide/project/tailwindcss.md → docs/src/guide/project/tailwindcss.md b/website/src/guide/project/tailwindcss.md → docs/src/guide/project/tailwindcss.md
diff --git a/website/src/guide/project/test.md → docs/src/guide/project/test.md b/website/src/guide/project/test.md → docs/src/guide/project/test.md
diff --git a/website/src/guide/project/vite.md → docs/src/guide/project/vite.md b/website/src/guide/project/vite.md → docs/src/guide/project/vite.md
diff --git a/website/src/index.md → docs/src/index.md b/website/src/index.md → docs/src/index.md
diff --git a/website/src/public/favicon.ico → docs/src/public/favicon.ico b/website/src/public/favicon.ico → docs/src/public/favicon.ico
diff --git a/website/src/public/guide/devtools.png → docs/src/public/guide/devtools.png b/website/src/public/guide/devtools.png → docs/src/public/guide/devtools.png
diff --git a/website/src/public/guide/loading.png → docs/src/public/guide/loading.png b/website/src/public/guide/loading.png → docs/src/public/guide/loading.png
diff --git a/website/src/public/guide/locale.png → docs/src/public/guide/locale.png b/website/src/public/guide/locale.png → docs/src/public/guide/locale.png
diff --git a/website/src/public/guide/login-expired.png → docs/src/public/guide/login-expired.png b/website/src/public/guide/login-expired.png → docs/src/public/guide/login-expired.png
diff --git a/website/src/public/guide/preferences.png → docs/src/public/guide/preferences.png b/website/src/public/guide/preferences.png → docs/src/public/guide/preferences.png
diff --git a/website/src/public/guide/qq.png → docs/src/public/guide/qq.png b/website/src/public/guide/qq.png → docs/src/public/guide/qq.png
diff --git a/website/src/public/guide/qq_channel.png → docs/src/public/guide/qq_channel.png b/website/src/public/guide/qq_channel.png → docs/src/public/guide/qq_channel.png
diff --git a/website/src/public/guide/report.png → docs/src/public/guide/report.png b/website/src/public/guide/report.png → docs/src/public/guide/report.png
diff --git a/website/src/public/guide/test.png → docs/src/public/guide/test.png b/website/src/public/guide/test.png → docs/src/public/guide/test.png
diff --git a/website/src/public/guide/update-notice.png → docs/src/public/guide/update-notice.png b/website/src/public/guide/update-notice.png → docs/src/public/guide/update-notice.png
diff --git a/website/src/public/logos/nitro.svg → docs/src/public/logos/nitro.svg b/website/src/public/logos/nitro.svg → docs/src/public/logos/nitro.svg
diff --git a/website/src/public/logos/shadcn-ui.svg → docs/src/public/logos/shadcn-ui.svg b/website/src/public/logos/shadcn-ui.svg → docs/src/public/logos/shadcn-ui.svg
diff --git a/website/src/public/logos/turborepo.svg → docs/src/public/logos/turborepo.svg b/website/src/public/logos/turborepo.svg → docs/src/public/logos/turborepo.svg
diff --git a/website/src/public/logos/vite.svg → docs/src/public/logos/vite.svg b/website/src/public/logos/vite.svg → docs/src/public/logos/vite.svg
diff --git a/website/src/sponsor/personal.md → docs/src/sponsor/personal.md b/website/src/sponsor/personal.md → docs/src/sponsor/personal.md
diff --git a/website/tsconfig.json → docs/tsconfig.json b/website/tsconfig.json → docs/tsconfig.json
diff --git a/internal/lint-configs/eslint-config/src/configs/typescript.ts b/internal/lint-configs/eslint-config/src/configs/typescript.ts
@@ -41,8 +41,7 @@ export async function typescript(): Promise<Linter.FlatConfig[]> {
         ],
 
         '@typescript-eslint/consistent-type-definitions': ['warn', 'interface'],
-        '@typescript-eslint/explicit-function-rkeyword-spacingeturn-type':
-          'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
         '@typescript-eslint/explicit-module-boundary-types': 'off',
         '@typescript-eslint/no-empty-function': [
           'error',

diff --git a/internal/lint-configs/eslint-config/src/custom-config.ts b/internal/lint-configs/eslint-config/src/custom-config.ts
@@ -116,7 +116,7 @@ const customConfig: Linter.FlatConfig[] = [
   },
   // 后端模拟代码，不需要太多规则
   {
-    files: ['apps/backend-mock/**/**', 'website/**/**'],
+    files: ['apps/backend-mock/**/**', 'docs/**/**'],
     rules: {
       '@typescript-eslint/no-extraneous-class': 'off',
       'n/no-extraneous-import': 'off',

diff --git a/package.json b/package.json
@@ -39,7 +39,7 @@
     "commit": "czg",
     "dev": "turbo-run dev",
     "dev:antd": "pnpm -F @vben/web-antd run dev",
-    "dev:docs": "pnpm -F @vben/website run dev",
+    "dev:docs": "pnpm -F @vben/docs run dev",
     "dev:ele": "pnpm -F @vben/web-ele run dev",
     "dev:naive": "pnpm -F @vben/web-naive run dev",
     "format": "vsh lint --format",

diff --git a/packages/@core/ui-kit/menu-ui/src/components/menu.vue b/packages/@core/ui-kit/menu-ui/src/components/menu.vue
@@ -507,12 +507,12 @@ $namespace: vben;
     }
 
     &.is-light {
-      --menu-item-active-color: hsl(var(--primary-foreground));
-      --menu-item-active-background-color: hsl(var(--primary));
+      --menu-item-active-color: hsl(var(--primary));
+      --menu-item-active-background-color: hsl(var(--primary) / 15%);
       --menu-item-hover-background-color: hsl(var(--accent));
       --menu-item-hover-color: hsl(var(--primary));
-      --menu-submenu-active-color: hsl(var(--primary-foreground));
-      --menu-submenu-active-background-color: hsl(var(--primary));
+      --menu-submenu-active-color: hsl(var(--primary));
+      --menu-submenu-active-background-color: hsl(var(--primary) / 30%);
       --menu-submenu-hover-color: hsl(var(--primary));
       --menu-submenu-hover-background-color: hsl(var(--accent));
     }

diff --git a/packages/effects/layouts/src/widgets/check-updates/check-updates.vue b/packages/effects/layouts/src/widgets/check-updates/check-updates.vue
@@ -22,6 +22,12 @@ const { toast } = useToast();
 
 async function getVersionTag() {
   try {
+    if (
+      location.hostname === 'localhost' ||
+      location.hostname === '127.0.0.1'
+    ) {
+      return null;
+    }
     const response = await fetch('/', {
       cache: 'no-cache',
       method: 'HEAD',
@@ -48,7 +54,7 @@ async function checkForUpdates() {
     return;
   }
 
-  if (lastVersionTag.value !== versionTag) {
+  if (lastVersionTag.value !== versionTag && versionTag) {
     clearInterval(timer.value);
     handleNotice(versionTag);
   }