From b98f9f9baa873256c05a63db3e8129b0eb90ab12 Mon Sep 17 00:00:00 2001
From: vince <vince292007@gmail.com>
Date: Sun, 28 Jul 2024 23:46:01 +0800
Subject: [PATCH] chore: update docs

---
 .github/workflows/deploy.yml            | 15 ++++++--
 website/src/guide/essentials/concept.md | 51 ++++++++++++++++++++++++-
 2 files changed, 61 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index c6e0e479..0851e5dd 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -6,8 +6,8 @@ on:
       - main
 
 jobs:
-  deploy-web-antd-ftp:
-    name: Deploy Web Antd
+  deploy-push-ftp:
+    name: Deploy Push Ftp
     if: github.actor != 'dependabot[bot]' && !contains(github.event.head_commit.message, '[skip ci]')
     runs-on: ubuntu-latest
     strategy:
@@ -41,11 +41,18 @@ jobs:
       - name: Build
         run: pnpm run build
 
-      - name: Sync files
+      - name: Sync Web Antd files
         uses: SamKirkland/FTP-Deploy-Action@v4.3.5
         with:
           server: ${{ secrets.PRO_FTP_HOST }}
           username: ${{ secrets.WEB_ANTD_FTP_ACCOUNT }}
           password: ${{ secrets.WEB_ANTD_FTP_PASSWORD }}
           local-dir: ./apps/web-antd/dist/
-          dangerous-clean-slate: true
+
+      - name: Sync Website 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/
diff --git a/website/src/guide/essentials/concept.md b/website/src/guide/essentials/concept.md
index f678f9d0..c7b64760 100644
--- a/website/src/guide/essentials/concept.md
+++ b/website/src/guide/essentials/concept.md
@@ -1,6 +1,6 @@
 # 基础概念
 
-新版本中，整体工程进行了重构，现在我们将会介绍一些基础名词概念，以便于你更好的理解整个文档。请务必仔先阅读这一部分。
+新版本中，整体工程进行了重构，现在我们将会介绍一些基础概念，以便于你更好的理解整个文档。请务必仔先阅读这一部分。
 
 ## 大仓
 
@@ -19,3 +19,52 @@
 ## 包
 
 包指的是一个独立的模块，可以是一个组件、一个工具、一个库等。包可以被多个应用引用，也可以被其他包引用。包都被放置在 `packages` 目录下。
+
+对于这些包，你可以把它看作是一个独立的 `npm` 包，使用方式与 `npm` 包一样。
+
+### 包引入
+
+在 `package.json` 中引入包：
+
+```json
+{
+  "dependencies": {
+    "@vben/utils": "workspace:*"
+  }
+}
+```
+
+### 包使用
+
+在代码中引入包：
+
+```ts
+import { isString } from '@vben/utils';
+```
+
+## 别名
+
+在项目中，你可以看到一些 `#` 开头的路径，例如： `#/api`、`#/views`, 这些路径都是别名，用于快速定位到某个目录。它不是通过 `vite` 的 `alias` 实现的，而是通过 `Node.js` 本身的 [subpath imports](https://nodejs.org/api/packages.html#subpath-imports) 原理。只需要在 `package.json` 中配置 `imports` 字段即可。
+
+```json
+{
+  "imports": {
+    "#/*": "./src/*"
+  }
+}
+```
+
+为了 IDE 能够识别这些别名，我们还需要在`tsconfig.json`内配置：
+
+```json
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "#/*": ["src/*"]
+    }
+  }
+}
+```
+
+这样，你就可以在代码中使用别名了。