Browse Source

chore: Rename the website directory to docs

pull/3993/head
vben 2 years ago
parent
commit
06ad5ad871
  1. 4
      .github/workflows/deploy.yml
  2. 2
      docs/.vitepress/config.mts
  3. 0
      docs/.vitepress/theme/components/site-layout.vue
  4. 0
      docs/.vitepress/theme/components/vben-contributors.vue
  5. 0
      docs/.vitepress/theme/index.ts
  6. 0
      docs/.vitepress/theme/plugins/hm.ts
  7. 0
      docs/.vitepress/theme/styles/base.css
  8. 0
      docs/.vitepress/theme/styles/index.ts
  9. 0
      docs/.vitepress/theme/styles/variables.css
  10. 2
      docs/package.json
  11. 0
      docs/src/commercial/community.md
  12. 0
      docs/src/commercial/customized.md
  13. 0
      docs/src/commercial/technical-support.md
  14. 0
      docs/src/en/guide/index.md
  15. 0
      docs/src/en/index.md
  16. 0
      docs/src/friend-links/index.md
  17. 0
      docs/src/guide/essentials/build.md
  18. 0
      docs/src/guide/essentials/concept.md
  19. 4
      docs/src/guide/essentials/development.md
  20. 0
      docs/src/guide/essentials/external-module.md
  21. 0
      docs/src/guide/essentials/icons.md
  22. 0
      docs/src/guide/essentials/route.md
  23. 0
      docs/src/guide/essentials/server.md
  24. 0
      docs/src/guide/essentials/settings.md
  25. 0
      docs/src/guide/essentials/styles.md
  26. 0
      docs/src/guide/in-depth/access.md
  27. 0
      docs/src/guide/in-depth/check-updates.md
  28. 0
      docs/src/guide/in-depth/features.md
  29. 0
      docs/src/guide/in-depth/layout.md
  30. 0
      docs/src/guide/in-depth/loading.md
  31. 0
      docs/src/guide/in-depth/locale.md
  32. 0
      docs/src/guide/in-depth/theme.md
  33. 0
      docs/src/guide/in-depth/ui-framework.md
  34. 0
      docs/src/guide/introduction/changelog.md
  35. 0
      docs/src/guide/introduction/quick-start.md
  36. 0
      docs/src/guide/introduction/roadmap.md
  37. 4
      docs/src/guide/introduction/vben.md
  38. 0
      docs/src/guide/introduction/why.md
  39. 0
      docs/src/guide/other/faq.md
  40. 0
      docs/src/guide/other/project-update.md
  41. 0
      docs/src/guide/other/remove-code.md
  42. 0
      docs/src/guide/project/changeset.md
  43. 0
      docs/src/guide/project/cli.md
  44. 0
      docs/src/guide/project/standard.md
  45. 0
      docs/src/guide/project/tailwindcss.md
  46. 0
      docs/src/guide/project/test.md
  47. 0
      docs/src/guide/project/vite.md
  48. 0
      docs/src/index.md
  49. 0
      docs/src/public/favicon.ico
  50. 0
      docs/src/public/guide/devtools.png
  51. 0
      docs/src/public/guide/loading.png
  52. 0
      docs/src/public/guide/locale.png
  53. 0
      docs/src/public/guide/login-expired.png
  54. 0
      docs/src/public/guide/preferences.png
  55. 0
      docs/src/public/guide/qq.png
  56. 0
      docs/src/public/guide/qq_channel.png
  57. 0
      docs/src/public/guide/report.png
  58. 0
      docs/src/public/guide/test.png
  59. 0
      docs/src/public/guide/update-notice.png
  60. 0
      docs/src/public/logos/nitro.svg
  61. 0
      docs/src/public/logos/shadcn-ui.svg
  62. 0
      docs/src/public/logos/turborepo.svg
  63. 0
      docs/src/public/logos/vite.svg
  64. 0
      docs/src/sponsor/personal.md
  65. 0
      docs/tsconfig.json
  66. 3
      internal/lint-configs/eslint-config/src/configs/typescript.ts
  67. 2
      internal/lint-configs/eslint-config/src/custom-config.ts
  68. 2
      package.json
  69. 8
      packages/@core/ui-kit/menu-ui/src/components/menu.vue
  70. 8
      packages/effects/layouts/src/widgets/check-updates/check-updates.vue
  71. 479
      pnpm-lock.yaml
  72. 2
      pnpm-workspace.yaml
  73. 8
      vben-admin.code-workspace

4
.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/

2
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',

0
website/.vitepress/theme/components/site-layout.vue → docs/.vitepress/theme/components/site-layout.vue

0
website/.vitepress/theme/components/vben-contributors.vue → docs/.vitepress/theme/components/vben-contributors.vue

0
website/.vitepress/theme/index.ts → docs/.vitepress/theme/index.ts

0
website/.vitepress/theme/plugins/hm.ts → docs/.vitepress/theme/plugins/hm.ts

0
website/.vitepress/theme/styles/base.css → docs/.vitepress/theme/styles/base.css

0
website/.vitepress/theme/styles/index.ts → docs/.vitepress/theme/styles/index.ts

0
website/.vitepress/theme/styles/variables.css → docs/.vitepress/theme/styles/variables.css

2
website/package.json → docs/package.json

@ -1,5 +1,5 @@
{
"name": "@vben/website",
"name": "@vben/docs",
"version": "5.0.0",
"private": true,
"scripts": {

0
website/src/commercial/community.md → docs/src/commercial/community.md

0
website/src/commercial/customized.md → docs/src/commercial/customized.md

0
website/src/commercial/technical-support.md → docs/src/commercial/technical-support.md

0
website/src/en/guide/index.md → docs/src/en/guide/index.md

0
website/src/en/index.md → docs/src/en/index.md

0
website/src/friend-links/index.md → docs/src/friend-links/index.md

0
website/src/guide/essentials/build.md → docs/src/guide/essentials/build.md

0
website/src/guide/essentials/concept.md → docs/src/guide/essentials/concept.md

4
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

0
website/src/guide/essentials/external-module.md → docs/src/guide/essentials/external-module.md

0
website/src/guide/essentials/icons.md → docs/src/guide/essentials/icons.md

0
website/src/guide/essentials/route.md → docs/src/guide/essentials/route.md

0
website/src/guide/essentials/server.md → docs/src/guide/essentials/server.md

0
website/src/guide/essentials/settings.md → docs/src/guide/essentials/settings.md

0
website/src/guide/essentials/styles.md → docs/src/guide/essentials/styles.md

0
website/src/guide/in-depth/access.md → docs/src/guide/in-depth/access.md

0
website/src/guide/in-depth/check-updates.md → docs/src/guide/in-depth/check-updates.md

0
website/src/guide/in-depth/features.md → docs/src/guide/in-depth/features.md

0
website/src/guide/in-depth/layout.md → docs/src/guide/in-depth/layout.md

0
website/src/guide/in-depth/loading.md → docs/src/guide/in-depth/loading.md

0
website/src/guide/in-depth/locale.md → docs/src/guide/in-depth/locale.md

0
website/src/guide/in-depth/theme.md → docs/src/guide/in-depth/theme.md

0
website/src/guide/in-depth/ui-framework.md → docs/src/guide/in-depth/ui-framework.md

0
website/src/guide/introduction/changelog.md → docs/src/guide/introduction/changelog.md

0
website/src/guide/introduction/quick-start.md → docs/src/guide/introduction/quick-start.md

0
website/src/guide/introduction/roadmap.md → docs/src/guide/introduction/roadmap.md

4
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)。

0
website/src/guide/introduction/why.md → docs/src/guide/introduction/why.md

0
website/src/guide/other/faq.md → docs/src/guide/other/faq.md

0
website/src/guide/other/project-update.md → docs/src/guide/other/project-update.md

0
website/src/guide/other/remove-code.md → docs/src/guide/other/remove-code.md

0
website/src/guide/project/changeset.md → docs/src/guide/project/changeset.md

0
website/src/guide/project/cli.md → docs/src/guide/project/cli.md

0
website/src/guide/project/standard.md → docs/src/guide/project/standard.md

0
website/src/guide/project/tailwindcss.md → docs/src/guide/project/tailwindcss.md

0
website/src/guide/project/test.md → docs/src/guide/project/test.md

0
website/src/guide/project/vite.md → docs/src/guide/project/vite.md

0
website/src/index.md → docs/src/index.md

0
website/src/public/favicon.ico → docs/src/public/favicon.ico

Before

Width:  |  Height:  |  Size: 5.3 KiB

After

Width:  |  Height:  |  Size: 5.3 KiB

0
website/src/public/guide/devtools.png → docs/src/public/guide/devtools.png

Before

Width:  |  Height:  |  Size: 393 KiB

After

Width:  |  Height:  |  Size: 393 KiB

0
website/src/public/guide/loading.png → docs/src/public/guide/loading.png

Before

Width:  |  Height:  |  Size: 87 KiB

After

Width:  |  Height:  |  Size: 87 KiB

0
website/src/public/guide/locale.png → docs/src/public/guide/locale.png

Before

Width:  |  Height:  |  Size: 471 KiB

After

Width:  |  Height:  |  Size: 471 KiB

0
website/src/public/guide/login-expired.png → docs/src/public/guide/login-expired.png

Before

Width:  |  Height:  |  Size: 556 KiB

After

Width:  |  Height:  |  Size: 556 KiB

0
website/src/public/guide/preferences.png → docs/src/public/guide/preferences.png

Before

Width:  |  Height:  |  Size: 123 KiB

After

Width:  |  Height:  |  Size: 123 KiB

0
website/src/public/guide/qq.png → docs/src/public/guide/qq.png

Before

Width:  |  Height:  |  Size: 447 KiB

After

Width:  |  Height:  |  Size: 447 KiB

0
website/src/public/guide/qq_channel.png → docs/src/public/guide/qq_channel.png

Before

Width:  |  Height:  |  Size: 448 KiB

After

Width:  |  Height:  |  Size: 448 KiB

0
website/src/public/guide/report.png → docs/src/public/guide/report.png

Before

Width:  |  Height:  |  Size: 1000 KiB

After

Width:  |  Height:  |  Size: 1000 KiB

0
website/src/public/guide/test.png → docs/src/public/guide/test.png

Before

Width:  |  Height:  |  Size: 249 KiB

After

Width:  |  Height:  |  Size: 249 KiB

0
website/src/public/guide/update-notice.png → docs/src/public/guide/update-notice.png

Before

Width:  |  Height:  |  Size: 400 KiB

After

Width:  |  Height:  |  Size: 400 KiB

0
website/src/public/logos/nitro.svg → docs/src/public/logos/nitro.svg

Before

Width:  |  Height:  |  Size: 3.3 KiB

After

Width:  |  Height:  |  Size: 3.3 KiB

0
website/src/public/logos/shadcn-ui.svg → docs/src/public/logos/shadcn-ui.svg

Before

Width:  |  Height:  |  Size: 472 B

After

Width:  |  Height:  |  Size: 472 B

0
website/src/public/logos/turborepo.svg → docs/src/public/logos/turborepo.svg

Before

Width:  |  Height:  |  Size: 4.0 KiB

After

Width:  |  Height:  |  Size: 4.0 KiB

0
website/src/public/logos/vite.svg → docs/src/public/logos/vite.svg

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 1.5 KiB

0
website/src/sponsor/personal.md → docs/src/sponsor/personal.md

0
website/tsconfig.json → docs/tsconfig.json

3
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',

2
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',

2
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",

8
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));
}

8
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);
}

479
pnpm-lock.yaml

File diff suppressed because it is too large

2
pnpm-workspace.yaml

@ -10,4 +10,4 @@ packages:
- "packages/business/*"
- "apps/*"
- "scripts/*"
- "website"
- "docs"

8
vben-admin.code-workspace

@ -16,6 +16,10 @@
"name": "@vben/web-naive",
"path": "apps/web-naive",
},
{
"name": "@vben/docs",
"path": "docs",
},
{
"name": "@vben/commitlint-config",
"path": "internal/lint-configs/commitlint-config",
@ -156,9 +160,5 @@
"name": "@vben/vsh",
"path": "scripts/vsh",
},
{
"name": "@vben/website",
"path": "website",
},
],
}

Loading…
Cancel
Save