From 7171d750ba90acc5bf967eba872d401ffdae5e25 Mon Sep 17 00:00:00 2001
From: Theo <fanxiaobin422@gmail.com>
Date: Mon, 19 Aug 2024 14:27:10 +0800
Subject: [PATCH] docs: Update documentation

---
 docs/guide/aside.md                        | 74 +++++++++++++++++
 docs/guide/footer.md                       | 93 ++++++++++++++++++++++
 packages/Lumen/components/DocAsideLogo.vue | 10 +--
 3 files changed, 172 insertions(+), 5 deletions(-)

diff --git a/docs/guide/aside.md b/docs/guide/aside.md
index 5e12b191..6b1dad52 100644
--- a/docs/guide/aside.md
+++ b/docs/guide/aside.md
@@ -58,3 +58,77 @@ export default {
  ... //其他代码
 }
 ```
+
+## 数据接口说明
+
+```ts
+/**
+ * `Aside_Data` 属性的类型定义。
+ *
+ * 该属性包含一个对象数组，每个对象代表一个横幅。具体字段如下：
+ *
+ * - `link` (string): 链接地址。
+ * - `icon` (string): 图标地址。
+ * - `name` (string, 可选): 名称。
+ * - `Activity` (string, 可选): 活动信息。
+ * - `hide1` (string, 可选): 隐藏信息1。
+ * - `info1` (string, 可选): 信息1。
+ * - `hide2` (string, 可选): 隐藏信息2。
+ * - `info2` (string, 可选): 信息2。
+ *
+ * 该属性为必需的。
+ */
+Aside_Data: {
+  type: Array as PropType<
+    Array<{
+      /**
+       * 链接地址。
+       */
+      link: string
+
+      /**
+       * 图标地址。
+       */
+      icon: string
+
+      /**
+       * 名称。
+       * @default undefined
+       */
+      name?: string
+
+      /**
+       * 活动信息。
+       * @default undefined
+       */
+      Activity?: string
+
+      /**
+       * 隐藏信息1。
+       * @default undefined
+       */
+      hide1?: string
+
+      /**
+       * 信息1。
+       * @default undefined
+       */
+      info1?: string
+
+      /**
+       * 隐藏信息2。
+       * @default undefined
+       */
+      hide2?: string
+
+      /**
+       * 信息2。
+       * @default undefined
+       */
+      info2?: string
+    }>
+  >,
+  required: true
+}
+
+```
diff --git a/docs/guide/footer.md b/docs/guide/footer.md
index 45676c1c..c9ec748f 100644
--- a/docs/guide/footer.md
+++ b/docs/guide/footer.md
@@ -50,3 +50,96 @@ export default defineConfig({
   ...//其他代码
 })
 ```
+
+## 数据接口说明
+
+```ts
+/**
+ * Footer 的数据对象。
+ */
+interface FooterData {
+  /**
+   * 各个 section 的数据。
+   */
+  group: Array<{
+    /**
+     * Section 的标题。
+     */
+    title: string
+
+    /**
+     * 图标的类名（Font Awesome 图标类名）。
+     * @default undefined
+     */
+    icon?: string
+
+    /**
+     * 该 section 下的链接。
+     */
+    links: Array<{
+      /**
+       * 链接文本。
+       */
+      name: string
+
+      /**
+       * 链接的图标类名（Font Awesome 图标类名）。
+       * @default undefined
+       */
+      icon?: string
+
+      /**
+       * 链接地址。
+       */
+      href: string
+
+      /**
+       * 链接是否为内部链接。
+       */
+      internal: boolean
+    }>
+  }>
+
+  /**
+   * 备案信息。
+   * @default undefined
+   */
+  beian?: {
+    /**
+     * ICP 备案号。
+     * @default undefined
+     */
+    icp?: string
+
+    /**
+     * 公安备案号。
+     * @default undefined
+     */
+    police?: string
+  }
+
+  /**
+   * 作者信息。
+   * @default undefined
+   */
+  author?: {
+    /**
+     * 作者名称。
+     * @default undefined
+     */
+    name?: string
+
+    /**
+     * 版权年份。
+     * @default undefined
+     */
+    time?: string
+
+    /**
+     * 作者的链接。
+     * @default undefined
+     */
+    link?: string
+  }
+}
+```
diff --git a/packages/Lumen/components/DocAsideLogo.vue b/packages/Lumen/components/DocAsideLogo.vue
index d76ec899..347e69eb 100644
--- a/packages/Lumen/components/DocAsideLogo.vue
+++ b/packages/Lumen/components/DocAsideLogo.vue
@@ -7,10 +7,10 @@ export default defineComponent({
     /**
      * `Aside_Data` 属性的类型定义。
      * 包含一个对象数组，每个对象代表一个横幅，具体字段如下：
-     * - `link`: 横幅的链接地址
-     * - `icon`: 横幅的图标地址
-     * - `name` (可选): 横幅的名称
-     * - `Activity` (可选): 横幅的活动信息
+     * - `link`: 链接地址
+     * - `icon`: 图标地址
+     * - `name` (可选): 名称
+     * - `Activity` (可选): 活动信息
      * - `hide1` (可选): 隐藏信息1
      * - `info1` (可选): 信息1
      * - `hide2` (可选): 隐藏信息2
@@ -39,7 +39,7 @@ export default defineComponent({
 
 <template>
   <div>
-    <!-- 遍历 Aside_Data 数组并渲染每个横幅 -->
+    <!-- 遍历 Aside_Data 数组并渲染 -->
     <a
       v-for="(banner, index) in Aside_Data"
       :key="index"