docs: update docs

.husky/post-merge

@@ -0,0 +1,3 @@
+# 每次 git pull 之后, 安装依赖
+
+pnpm install

apps/web-antd/src/layouts/basic.vue

@@ -13,7 +13,7 @@ import { preferences } from '@vben-core/preferences';
 
 import { $t } from '#/locales';
 import { resetRoutes } from '#/router';
-import { useAppStore } from '#/store';
+import { useAccessStore, useAppStore } from '#/store';
 
 const notifications = ref<NotificationItem[]>([
   {
@@ -81,6 +81,7 @@ const menus = computed(() => [
 ]);
 
 const appStore = useAppStore();
+const { userInfo } = useAccessStore();
 const router = useRouter();
 
 async function handleLogout() {
@@ -102,11 +103,11 @@ function handleMakeAll() {
   <BasicLayout @clear-preferences-and-logout="handleLogout">
     <template #user-dropdown>
       <UserDropdown
-        :avatar="preferences.app.defaultAvatar"
+        :avatar="userInfo?.avatar ?? preferences.app.defaultAvatar"
         :menus="menus"
+        :text="userInfo?.realName"
         description="[email protected]"
         tag-text="Pro"
-        text="Vben Admin"
         @logout="handleLogout"
       />
     </template>

apps/web-antd/vite.config.mts

@@ -27,12 +27,12 @@ export default defineConfig({
           icons: [
             {
               sizes: '192x192',
-              src: 'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected].1/source/pwa-icon-192.png',
+              src: 'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected].3/source/pwa-icon-192.png',
               type: 'image/png',
             },
             {
               sizes: '512x512',
-              src: 'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected].1/source/pwa-icon-512.png',
+              src: 'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected].3/source/pwa-icon-512.png',
               type: 'image/png',
             },
           ],

internal/lint-configs/eslint-config/src/custom-config.ts

@@ -7,7 +7,7 @@ const restrictedImportIgnores = [
 ];
 
 const customConfig: Linter.FlatConfig[] = [
-  // shadcn-ui 内部组件是自动生成的，这里忽略
+  // shadcn-ui 内部组件是自动生成的，不做太多限制
   {
     files: ['packages/@core/ui-kit/shadcn-ui/**/**'],
     rules: {
@@ -61,7 +61,6 @@ const customConfig: Linter.FlatConfig[] = [
       'no-restricted-imports': [
         'error',
         {
-          // 如果需要，可以指定禁止特定的子路径
           patterns: [
             {
               group: ['@vben/*'],
@@ -81,7 +80,6 @@ const customConfig: Linter.FlatConfig[] = [
       'no-restricted-imports': [
         'error',
         {
-          // 如果需要，可以指定禁止特定的子路径
           patterns: [
             {
               group: ['@vben/*', '@vben-core/*'],
@@ -107,7 +105,6 @@ const customConfig: Linter.FlatConfig[] = [
       'no-restricted-imports': [
         'error',
         {
-          // 如果需要，可以指定禁止特定的子路径
           patterns: [
             {
               group: ['@vben/*'],

packages/@core/forward/preferences/src/config.ts

@@ -10,7 +10,7 @@ const defaultPreferences: Preferences = {
     compact: false,
     contentCompact: 'wide',
     defaultAvatar:
-      'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected].0/source/avatar-v1.webp',
+      'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected].3/source/avatar-v1.webp',
     dynamicTitle: true,
     enablePreferences: true,
     isMobile: false,
@@ -46,7 +46,7 @@ const defaultPreferences: Preferences = {
   logo: {
     enable: true,
     source:
-      'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected].0/source/logo-v1.webp',
+      'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected].3/source/logo-v1.webp',
   },
   navigation: {
     accordion: true,

packages/@core/shared/iconify/build.config.ts

@@ -0,0 +1,7 @@
+import { defineBuildConfig } from 'unbuild';
+
+export default defineBuildConfig({
+  clean: true,
+  declaration: true,
+  entries: ['src/index'],
+});

packages/@core/shared/iconify/package.json

@@ -10,14 +10,28 @@
   },
   "license": "MIT",
   "type": "module",
+  "scripts": {
+    "build": "pnpm unbuild",
+    "stub": "pnpm unbuild --stub"
+  },
   "files": [
     "dist"
   ],
-  "main": "./src/index.ts",
-  "module": "./src/index.ts",
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
   "exports": {
     ".": {
-      "default": "./src/index.ts"
+      "types": "./src/index.ts",
+      "development": "./src/index.ts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "publishConfig": {
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      }
     }
   },
   "dependencies": {

packages/business/widgets/src/preferences/blocks/layout/copyright.vue

@@ -1,4 +1,6 @@
 <script setup lang="ts">
+import { computed } from 'vue';
+
 import { $t } from '@vben-core/locales';
 
 import InputItem from '../input-item.vue';
@@ -8,6 +10,8 @@ defineOptions({
   name: 'PreferenceBreadcrumbConfig',
 });
 
+const props = defineProps<{ disabled: boolean }>();
+
 const copyrightEnable = defineModel<boolean>('copyrightEnable');
 const copyrightDate = defineModel<string>('copyrightDate');
 const copyrightIcp = defineModel<string>('copyrightIcp');
@@ -16,27 +20,29 @@ const copyrightCompanyName = defineModel<string>('copyrightCompanyName');
 const copyrightCompanySiteLink = defineModel<string>(
   'copyrightCompanySiteLink',
 );
+
+const itemDisabled = computed(() => props.disabled || !copyrightEnable.value);
 </script>
 
 <template>
-  <SwitchItem v-model="copyrightEnable">
+  <SwitchItem v-model="copyrightEnable" :disabled="disabled">
     {{ $t('preferences.copyright.enable') }}
   </SwitchItem>
 
-  <InputItem v-model="copyrightCompanyName" :disabled="!copyrightEnable">
+  <InputItem v-model="copyrightCompanyName" :disabled="itemDisabled">
     {{ $t('preferences.copyright.company-name') }}
   </InputItem>
-  <InputItem v-model="copyrightCompanySiteLink" :disabled="!copyrightEnable">
+  <InputItem v-model="copyrightCompanySiteLink" :disabled="itemDisabled">
     {{ $t('preferences.copyright.company-site-link') }}
   </InputItem>
-  <InputItem v-model="copyrightDate" :disabled="!copyrightEnable">
+  <InputItem v-model="copyrightDate" :disabled="itemDisabled">
     {{ $t('preferences.copyright.date') }}
   </InputItem>
 
-  <InputItem v-model="copyrightIcp" :disabled="!copyrightEnable">
+  <InputItem v-model="copyrightIcp" :disabled="itemDisabled">
     {{ $t('preferences.copyright.icp') }}
   </InputItem>
-  <InputItem v-model="copyrightIcpLink" :disabled="!copyrightEnable">
+  <InputItem v-model="copyrightIcpLink" :disabled="itemDisabled">
     {{ $t('preferences.copyright.icp-link') }}
   </InputItem>
 </template>

packages/business/widgets/src/preferences/preferences.vue

@@ -351,6 +351,7 @@ async function handleReset() {
                 v-model:copyright-enable="copyrightEnable"
                 v-model:copyright-icp="copyrightIcp"
                 v-model:copyright-icp-link="copyrightIcpLink"
+                :disabled="!footerEnable"
               />
             </Block>
           </template>

packages/constants/src/vben.ts

@@ -7,5 +7,5 @@ const VBEN_GITHUB_URL = 'https://github.com/vbenjs/vue-vben-admin';
  * @zh_CN Vben Logo
  */
 const VBEN_LOGO =
-  'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected].1/source/logo-v1.webp';
+  'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected].3/source/logo-v1.webp';
 export { VBEN_GITHUB_URL, VBEN_LOGO };

website/.vitepress/config.mts

@@ -1,15 +1,35 @@
 import { defineConfigWithTheme } from 'vitepress';
 
 export default defineConfigWithTheme({
-  description: 'Vben Admin Pro Doc',
+  description: 'Vben Admin Pro & 企业级管理系统框架',
   lang: 'zh-CN',
+
+  locales: {
+    en: {
+      label: 'English',
+      lang: 'en',
+      link: '/en/index',
+    },
+    root: {
+      label: '简体中文',
+      lang: 'zh-CN',
+    },
+  },
   srcDir: 'src',
   themeConfig: {
+    editLink: {
+      pattern: 'https://github.com/vbenjs/vue-vben-admin/edit/main/docs/:path',
+      text: 'Edit this page on GitHub',
+    },
+    footer: {
+      copyright: 'Copyright © 2024-present Vben Admin Pro',
+    },
+    i18nRouting: true,
+    logo: 'https://cdn.jsdelivr.net/npm/@vbenjs/[email protected]/source/logo-v1.webp',
     nav: [
       { link: '/', text: 'Home' },
       { link: '/markdown-examples', text: 'Examples' },
     ],
-
     sidebar: [
       {
         text: 'Examples',
@@ -19,12 +39,11 @@ export default defineConfigWithTheme({
         ],
       },
     ],
-
+    siteTitle: 'Vben Admin Pro',
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/vuejs/vitepress' },
+      { icon: 'github', link: 'https://github.com/vbenjs/vue-vben-admin' },
     ],
   },
-  title: 'Vben Admin Pro',
   vite: {
     build: {
       chunkSizeWarningLimit: Infinity,

website/src/en/index.md

@@ -0,0 +1,28 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+sidebar: false
+
+hero:
+  name: 'Vben Admin Pro'
+  text: '企业级管理系统框架 - EN'
+  tagline: 开箱即用，简单高效
+  image:
+    src: https://cdn.jsdelivr.net/npm/@vbenjs/[email protected]/source/logo-v1.webp
+    alt: Vben Admin Pro
+  actions:
+    - theme: brand
+      text: 开始
+      link: /guide/
+    - theme: alt
+      text: 在 GitHub 查看
+      link: https://github.com/vbenjs/vue-vben-admin
+
+features:
+  - title: Feature A
+    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: Feature B
+    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: Feature C
+    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+---

website/src/index.md

@@ -1,18 +1,22 @@
 ---
 # https://vitepress.dev/reference/default-theme-home-page
 layout: home
+sidebar: false
 
 hero:
-  name: 'My Awesome Project'
-  text: 'A VitePress Site'
-  tagline: My great project tagline
+  name: 'Vben Admin Pro'
+  text: '企业级管理系统框架'
+  tagline: 开箱即用，简单高效
+  image:
+    src: https://cdn.jsdelivr.net/npm/@vbenjs/[email protected]/source/logo-v1.webp
+    alt: Vben Admin Pro
   actions:
     - theme: brand
-      text: Markdown Examples
-      link: /markdown-examples
+      text: 开始
+      link: /guide/
     - theme: alt
-      text: API Examples
-      link: /api-examples
+      text: 在 GitHub 查看
+      link: https://github.com/vbenjs/vue-vben-admin
 
 features:
   - title: Feature A