feat: 🚀 添加 catalogue 插件，优化其他插件代码，文章页添加作者、发布时间、面包屑功能，首页添加图标

Author: Kele-Bingtang

docs/.vitepress/cache/deps/_metadata.json

@@ -1,56 +1,65 @@
 {
-  "hash": "4e9d9a5f",
-  "configHash": "cd19b2e9",
-  "lockfileHash": "418faa5b",
-  "browserHash": "42bca078",
+  "hash": "bed69f4d",
+  "configHash": "f2098492",
+  "lockfileHash": "8ff230ec",
+  "browserHash": "1bc836ef",
   "optimized": {
     "vue": {
       "src": "../../../../node_modules/.pnpm/[email protected][email protected]/node_modules/vue/dist/vue.runtime.esm-bundler.js",
       "file": "vue.js",
-      "fileHash": "c116dd30",
+      "fileHash": "c4a03ef2",
       "needsInterop": false
     },
     "vitepress > @vue/devtools-api": {
       "src": "../../../../node_modules/.pnpm/@[email protected]/node_modules/@vue/devtools-api/dist/index.js",
       "file": "vitepress___@vue_devtools-api.js",
-      "fileHash": "a054176d",
+      "fileHash": "8a625078",
       "needsInterop": false
     },
     "vitepress > @vueuse/core": {
       "src": "../../../../node_modules/.pnpm/@[email protected][email protected]/node_modules/@vueuse/core/index.mjs",
       "file": "vitepress___@vueuse_core.js",
-      "fileHash": "cc67045e",
+      "fileHash": "81df7691",
       "needsInterop": false
     },
     "vitepress > @vueuse/integrations/useFocusTrap": {
       "src": "../../../../node_modules/.pnpm/@[email protected][email protected][email protected][email protected]/node_modules/@vueuse/integrations/useFocusTrap.mjs",
       "file": "vitepress___@vueuse_integrations_useFocusTrap.js",
-      "fileHash": "28c56b15",
+      "fileHash": "0dae493e",
       "needsInterop": false
     },
     "vitepress > mark.js/src/vanilla.js": {
       "src": "../../../../node_modules/.pnpm/[email protected]/node_modules/mark.js/src/vanilla.js",
       "file": "vitepress___mark__js_src_vanilla__js.js",
-      "fileHash": "c2197e44",
+      "fileHash": "fb61c6c3",
       "needsInterop": false
     },
     "vitepress > minisearch": {
       "src": "../../../../node_modules/.pnpm/[email protected]/node_modules/minisearch/dist/es/index.js",
       "file": "vitepress___minisearch.js",
-      "fileHash": "01611d6e",
+      "fileHash": "235c25ae",
       "needsInterop": false
     },
     "element-plus": {
       "src": "../../../../node_modules/.pnpm/[email protected][email protected][email protected]_/node_modules/element-plus/es/index.mjs",
       "file": "element-plus.js",
-      "fileHash": "895ec0d5",
+      "fileHash": "5887a0fb",
+      "needsInterop": false
+    },
+    "@element-plus/icons-vue": {
+      "src": "../../../../node_modules/.pnpm/@[email protected][email protected][email protected]_/node_modules/@element-plus/icons-vue/dist/index.js",
+      "file": "@element-plus_icons-vue.js",
+      "fileHash": "d4aef368",
       "needsInterop": false
     }
   },
   "chunks": {
     "chunk-QY2276BV": {
       "file": "chunk-QY2276BV.js"
     },
+    "chunk-6QBDH6GL": {
+      "file": "chunk-6QBDH6GL.js"
+    },
     "chunk-3ZOFCUNA": {
       "file": "chunk-3ZOFCUNA.js"
     },

docs/01.指南/a.md

@@ -15,8 +15,6 @@ description: aaaas啊实打实的
 sticky: true
 ---
 
-## Spring 是什么？
-
 ::: tip
 存寿生产厂商
 :::

docs/32.Spring生态/10.Spring/02.Spring6 - 概述.md

@@ -0,0 +1,156 @@
+---
+title: 使用 - AS
+date: 2025-12-12 19:00:00
+permalink: /a
+---
+
+## 设计思路
+
+对于一些登录之后才能访问的接口（例如：查询我的账号资料），我们通常的做法是增加一层接口校验：
+
+- 如果校验通过，则：正常返回数据
+- 如果校验未通过，则：抛出异常，告知其需要先进行登录
+
+那么，判断会话是否登录的依据是什么？我们先来简单分析一下登录访问流程：
+
+1. 用户提交 `name` + `password` 参数，调用登录接口
+2. 登录成功，返回这个用户的 Token 会话令牌
+3. 用户后续的每次请求，都携带上这个 Token
+4. 服务器根据 Token 判断此会话是否登录成功
+
+所谓登录认证，指的就是服务器校验账号密码，为用户颁发 Token 会话令牌的过程，这个 Token 也是我们后续判断会话是否登录的关键所在。
+
+## 登录与注销
+
+根据以上思路，我们需要一个会话登录的函数：
+
+```java
+// 会话登录：参数填写要登录的账号 id，建议的数据类型：long | int | String， 不可以传入复杂类型，如：User、Admin 等等
+HdHelper.login(Object id);
+```
+
+只此一句代码，便可以使会话登录成功，实际上，Hd Security 在背后做了大量的工作，包括但不限于：
+
+1. 检查此账号是否之前已有登录
+2. 为账号生成 `Token` 令牌与 `Session` 会话
+3. 记录 Token 活跃时间
+4. 通知全局侦听器，xx 账号登录成功
+5. 将 `Token` 注入到请求上下文
+6. ……
+
+你暂时不需要完整了解整个登录过程，你只需要记住关键一点：`Hd Security 为这个账号创建了一个 Token 令牌，且通过 Cookie 上下文返回给了前端`。
+
+所以一般情况下，我们的登录接口代码，会大致类似如下：
+
+```java
+// 会话登录接口
+@RequestMapping("doLogin")
+public HdResponse<String> doLogin(String name, String pwd) {
+    // 第一步：比对前端提交的账号名称、密码
+    if("Tianke".equals(name) && "123456".equals(pwd)) {
+        // 第二步：根据账号 id，进行登录
+        HdHelper.login(10001);
+        return HdResponse.ok("登录成功");
+    }
+    return HdResponse.error("登录失败");
+}
+```
+
+如果你对以上代码阅读没有压力，你可能会注意到略显奇怪的一点：此处仅仅做了会话登录，但并没有主动向前端返回 token 信息。 是因为不需要吗？严格来讲是需要的，只不过 `HdHelper.login(id)` 方法利用了 Cookie 自动注入的特性，省略了你手写返回 token 的代码。
+
+::: info Cookie 是什么？
+
+如果你对 Cookie 功能还不太了解，也不用担心，我们会在之后的 [ 前后端分离 ] 章节中详细的阐述 Cookie 功能，现在你只需要了解最基本的两点：
+
+- Cookie 可以从后端控制往浏览器中写入 token 值。
+- Cookie 会在前端每次发起请求时自动提交 token 值。
+
+因此，在 Cookie 功能的加持下，我们可以仅靠 `HdHelper.login(id)` 一句代码就完成登录认证。
+
+:::
+
+除了登录方法，我们还需要：
+
+```java
+// 当前会话注销登录
+HdHelper.logout();
+
+// 获取当前会话是否已经登录，返回 true 已登录，false 未登录
+HdHelper.isLogin();
+
+// 检验当前会话是否已经登录, 如果未登录，则抛出异常：`HdSecurityLoginException`
+HdHelper.checkLogin();
+```
+
+## 会话查询
+
+```java
+// 获取当前会话账号id, 如果未登录，则返回 null
+HdHelper.getLoginId();
+
+// ---------- 指定未登录情形下返回的默认值 ----------
+
+// 获取当前会话账号 id, 如果未登录，则返回默认值 （`defaultValue`可以为任意类型）
+HdHelper.loginHelper().getLoginId(Object defaultValue);
+```
+
+## token 查询
+
+```java
+// 获取当前会话的 token 值
+HdHelper.getWebToken();
+
+// 获取指定 token 对应的账号 id，如果未登录，则返回 null
+HdHelper.getLoginIdByToken(String token);
+
+// 获取当前会话剩余有效期（单位：s，返回 -1 代表永久有效）
+HdHelper.tokenHelper().getTokenAndLoginIdExpireTime();
+
+// 获取 Token 的基本信息
+HdHelper.getTokenInfo();
+```
+
+## 完整 Demo
+
+新建 `LoginController`
+
+```java
+/**
+ * 登录测试
+ */
+@RestController
+@RequestMapping("/login")
+public class LoginController {
+
+    // 测试登录  ---- http://localhost:8081/login/doLogin?name=zhang&pwd=123456
+    @RequestMapping("doLogin")
+    public HdResponse<String> doLogin(String name, String pwd) {
+        // 此处仅作模拟示例，真实项目需要从数据库中查询数据进行比对
+        if("Tianke".equals(name) && "123456".equals(pwd)) {
+            HdResponse.login(10001);
+            return HdResponse.okMessage("登录成功");
+        }
+        return HdResponse.errorMessage("登录失败");
+    }
+
+    // 查询登录状态  ---- http://localhost:8081/login/isLogin
+    @RequestMapping("isLogin")
+    public HdResponse<String> isLogin() {
+        return HdResponse.okMessage("是否登录：" + Hdhelper.isLogin());
+    }
+
+    // 查询 Token 信息  ---- http://localhost:8081/login/tokenInfo
+    @RequestMapping("tokenInfo")
+    public HdResponse<String> tokenInfo() {
+        return HdResponse.okMessage(Hdhelper.getTokenInfo());
+    }
+
+    // 测试注销  ---- http://localhost:8081/login/logout
+    @RequestMapping("logout")
+    public HdResponse<String> logout() {
+        Hdhelper.logout();
+        return HdResponse.ok();
+    }
+
+}
+```

docs/a.md

@@ -10,7 +10,7 @@
   ],
   "scripts": {
     "preinstall": "npx only-allow pnpm",
-    "postinstall": "pnpm stub:theme && pnpm stub:build && pnpm stub:sidebar && pnpm stub:permalink && pnpm stub:mdH1",
+    "postinstall": "pnpm stub:theme && pnpm stub:build && pnpm stub:sidebar && pnpm stub:permalink && pnpm stub:mdH1 && pnpm stub:catalogue",
     "docs:dev": "pnpm run -C docs dev",
     "docs:build": "pnpm run -C docs build",
     "docs:preview": "pnpm run -C docs preview",
@@ -21,6 +21,7 @@
     "stub:sidebar": "pnpm run -C plugins/vitepress-plugin-sidebar-resolve stub",
     "stub:permalink": "pnpm run -C plugins/vitepress-plugin-permalink stub",
     "stub:mdH1": "pnpm run -C plugins/vitepress-plugin-md-h1 stub",
+    "stub:catalogue": "pnpm run -C plugins/vitepress-plugin-catalogue stub",
     "lint:lint-staged": "lint-staged -c ./.husky/lintstagedrc.js",
     "lint:prettier": "prettier --write  \"src/**/*.{js,ts,json,tsx,css,less,scss,vue,html,md}\"",
     "lint:eslint": "eslint --max-warnings 0  \"{src,mock,build}/**/*.{vue,js,ts,tsx}\" --fix",

package.json

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

plugins/vitepress-plugin-catalogue/build.config.ts

@@ -0,0 +1,24 @@
+{
+  "name": "vitepress-plugin-catalogue",
+  "version": "1.0.0",
+  "description": "catalogue",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "scripts": {
+    "stub": "unbuild --stub"
+  },
+  "devDependencies": {
+    "gray-matter": "^4.0.3",
+    "unbuild": "^3.2.0",
+    "vite": "^6.0.7"
+  }
+}

plugins/vitepress-plugin-catalogue/package.json

@@ -0,0 +1,89 @@
+import { readdirSync, readFileSync, statSync } from "node:fs";
+import { basename, extname, join, resolve } from "node:path";
+import matter from "gray-matter";
+import type { CatalogueOption } from "./types";
+
+// 默认扫描的文件夹列表
+export const DEFAULT_INCLUDE_DIR = ["目录页"];
+
+let catalogues: Record<string, string> = {};
+
+export default (option: CatalogueOption = {}) => {
+  const { base = ".", includeList = [] } = option;
+  const sourceDir = join(process.cwd(), base);
+
+  // 获取指定根目录下的所有目录绝对路径
+  const dirPaths = readDirPaths(sourceDir, includeList);
+
+  // 遍历根目录下的每个子目录
+  dirPaths.forEach(dirPath => scannerMdFile(dirPath, option, basename(dirPath)));
+
+	return catalogues;
+};
+
+/**
+ * 指定根目录下的所有目录绝对路径，win 如 ['D:\docs\01.guide', 'D:\docs\02.design']，linux 如 ['/usr/local/docs/01.guide', '/usr/local/docs/02.design']
+ * @param sourceDir 指定文件/文件夹的根目录
+ */
+const readDirPaths = (sourceDir: string, includeList: CatalogueOption["includeList"] = []) => {
+  const includeListAll = [...DEFAULT_INCLUDE_DIR, ...includeList];
+  const dirPaths: string[] = [];
+  // 读取目录，返回数组，成员是 root 下所有的目录名（包含文件夹和文件，不递归）
+  const secondDirNames = readdirSync(sourceDir);
+
+  secondDirNames.forEach(secondDirName => {
+    // 将路径或路径片段的序列解析为绝对路径，等于使用 cd 命令
+    const secondDirPath = resolve(sourceDir, secondDirName);
+    // 是否为文件夹目录，并排除指定文件夹
+    if (isSome(includeListAll, secondDirName) && statSync(secondDirPath).isDirectory()) {
+      dirPaths.push(secondDirPath);
+    }
+  });
+
+  return dirPaths;
+};
+
+const scannerMdFile = (root: string, option: CatalogueOption, prefix = "") => {
+  const { includeList = [] } = option;
+  const includeListAll = [...DEFAULT_INCLUDE_DIR, ...includeList];
+  // 读取目录名（文件和文件夹）
+  let secondDirOrFilenames = readdirSync(root);
+
+  secondDirOrFilenames.forEach(dirOrFilename => {
+    const filePath = resolve(root, dirOrFilename);
+
+    if (statSync(filePath).isDirectory()) {
+      // 是文件夹目录
+      if (!isSome(includeListAll, dirOrFilename)) return;
+
+      scannerMdFile(filePath, option, `${prefix}/${dirOrFilename}`);
+    } else {
+      // 是文件
+      if (!isMdFile(dirOrFilename)) return;
+
+      const content = readFileSync(filePath, "utf-8");
+
+      // 解析出 front matter 数据
+      const { data: { catalogue, path = "" } = {} } = matter(content, {});
+
+      if (catalogue && path) {
+        const filename = basename(dirOrFilename, extname(dirOrFilename));
+        catalogues[`${prefix}/${filename}`] = path;
+      }
+    }
+  });
+};
+
+/**
+ * 判断是否为 md 文件
+ *
+ * @param filePath 文件绝对路径
+ */
+const isMdFile = (filePath: string) => {
+  const fileExtension = filePath.substring(filePath.lastIndexOf(".") + 1);
+  return ["md", "MD"].includes(fileExtension);
+};
+
+const isSome = (arr: Array<string | RegExp>, name: string) => {
+  return arr.some(item => name.includes(item as string) || (item instanceof RegExp && item.test(name)));
+};