Commit 7e0340d

@@ -1,86 +1,269 @@
 import type I18nKey from '@i18n/I18nKey';
 
+export type ButtonSubConfig = (
+  | {
+      /**
+       * The icon of the button. Should be a name of iconify icon.
+       *
+       * 按钮的图标。应该是一个 iconify 图标的名称。
+       */
+      icon: string;
+      /**
+       * The text of the button.
+       *
+       * 按钮的文本。
+       */
+      text?: string | I18nKey;
+    }
+  | {
+      /**
+       * The text of the button.
+       *
+       * 按钮的文本。
+       */
+      text: string | I18nKey;
+    }
+) &
+  (
+    | {
+        /**
+         * The URL of the button.
+         *
+         * 按钮的 URL。
+         */
+        href?: string;
+      }
+    | {
+        /**
+         * The function to be called when the button is clicked.
+         *
+         * 当按钮被点击时要调用的函数。
+         */
+        onclick?:
+          | string
+          | {
+              id: string;
+              function: (this: HTMLElement, ev: MouseEvent) => unknown;
+            };
+      }
+  );
+
 export type SiteConfig = {
+  /**
+   * The title of the site.
+   *
+   * 站点的标题。
+   */
   title: string;
+  /**
+   * The subtitle of the site.
+   *
+   * 站点的副标题。
+   */
   subtitle: string;
+  /**
+   * The language of the site.
+   *
+   * 站点的语言。
+   */
   lang: string;
+  /**
+   * The favicon of the site.
+   *
+   * 站点的 favicon。
+   */
   favicon: (string | { src: string; theme?: 'light' | 'dark' })[];
+  /**
+   * The number of posts displayed per page.
+   *
+   * 每页显示的文章数量。
+   */
   postsPerPage: number;
 };
 
 export type ProfileConfig = {
+  /**
+   * The avatar of the profile.
+   *
+   * 头像。
+   */
   avatar: string;
+  /**
+   * The name of the profile.
+   *
+   * 名字。
+   */
   name: string;
+  /**
+   * The bio of the profile.
+   *
+   * 简介。
+   */
   bio?: string;
+  /**
+   * The links of the profile.
+   *
+   * 链接。
+   */
   links: {
+    /**
+     * The title of the link.
+     *
+     * 链接的标题。
+     */
     name: string;
+    /**
+     * The URL of the link.
+     *
+     * 链接的 URL。
+     */
     url: string;
+    /**
+     * The icon of the link. Should be a name of iconify icon.
+     *
+     * 链接的图标。应该是一个 iconify 图标的名称。
+     */
     icon: string;
   }[];
 };
 
 export type NavbarConfig = {
+  /**
+   * The items displayed in the center of the navbar.
+   *
+   * 在导航栏中间显示的项目。
+   */
   navbarCenterItems: { text: string | I18nKey; href?: string }[];
+  /**
+   * The items displayed in the right of the navbar.
+   *
+   * 在导航栏右侧显示的项目。
+   */
   navbarRightItems: {
-    onlyWide: {
-      icon: string;
-      text: string | I18nKey;
-      href?: string;
-      onclick?:
-        | string
-        | {
-            id: string;
-            function: (this: HTMLElement, ev: MouseEvent) => unknown;
-          };
-    }[];
-    always: {
-      icon: string;
-      text: string | I18nKey;
-      href?: string;
-      onclick?:
-        | string
-        | {
-            id: string;
-            function: (this: HTMLElement, ev: MouseEvent) => unknown;
-          };
-    }[];
+    /**
+     * The items displayed only in wide screen (greater than 768px).
+     *
+     * 仅在宽屏幕（大于 768px）显示的项目。
+     */
+    onlyWide: ButtonSubConfig[];
+    /**
+     * The items displayed always.
+     *
+     * 总是显示的项目。
+     */
+    always: ButtonSubConfig[];
   };
 };
 
 export type ToolBarConfig = {
+  /**
+   * Whether to enable the side toolbar.
+   *
+   * 是否启用侧边工具栏。
+   */
   enable: boolean;
-  items: {
-    icon: string;
-    text?: string;
-    href?: string;
-    onclick?: string;
-  }[];
+  /**
+   * The items displayed in the side toolbar.
+   *
+   * 在侧边工具栏中显示的项目。
+   */
+  items: ButtonSubConfig[];
 };
 
 export type LicenseConfig = {
+  /**
+   * Whether to enable the license.
+   *
+   * 是否启用许可证。
+   */
   enable: boolean;
+  /**
+   * The name of the license.
+   *
+   * 许可证的名称。
+   */
   name: string;
+  /**
+   * The link of the license.
+   *
+   * 许可证的链接。
+   */
   url: string;
 };
 
 export type FooterConfig = {
+  /**
+   * The start year of the copyright.
+   *
+   * 版权开始年份。
+   */
   copyrightYear: number;
+  /**
+   * The items displayed in the right of the footer.
+   *
+   * 在页脚右侧显示的项目。
+   */
   rightItems: (string | { text: string; link?: string; class?: string })[][];
 };
 
 export type ArticleConfig = {
+  /**
+   * Whether to enable the table of contents.
+   *
+   * 是否启用目录。
+   */
   toc: boolean;
+  /**
+   * Whether to enable the word count.
+   *
+   * 是否启用字数统计。
+   */
   wordCount: boolean;
+  /**
+   * The configuration of the reading time.
+   *
+   * 阅读时间的配置。
+   */
   readingTime: {
+    /**
+     * Whether to enable the reading time.
+     *
+     * 是否启用阅读时间。
+     */
     enable: boolean;
+    /**
+     * The words per minute of the reading time.
+     *
+     * 阅读时间的每分钟字数。
+     */
     wordsPerMinute: {
+      /**
+       * The words per minute of CJK characters.
+       *
+       * CJK 字符的每分钟阅读字数。
+       */
       cjk: number;
+      /**
+       * The words per minute of non-CJK words.
+       *
+       * 非 CJK 单词的每分钟阅读字数。
+       */
       nonCjk: number;
     };
   };
 };
 
 export type SearchConfig = {
+  /** Whether to enable search.
+   *
+   * 是否启用搜索。
+   */
   enable: boolean;
+  /** `'pagefind'` | `'algolia'`.
+   *
+   * Algolia is not implemented yet, just a placeholder. Please use Pagefind.
+   *
+   * Algolia 尚未实现，只是一个占位符。请使用 Pagefind。
+   */
   provider: 'pagefind' | 'algolia';
 };

@@ -46,8 +46,6 @@ export const navbarConfig: NavbarConfig = {
   ],
   navbarRightItems: {
     onlyWide: [
-      // Items displayed only when the width is greater than 768px.
-      // 仅在宽度大于 768px 时显示的项目
       {
         icon: 'material-symbols:rss-feed-rounded',
         text: I18nKey.subscribe,