整理目录

packages/docusaurus-plugin-content-docs-ex/README.md

@@ -0,0 +1,3 @@
+# docuasaurus-plugin-content-docs 功能
+
+读取文档更多的详细信息

packages/docusaurus-plugin-content-docs-ex/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "docusaurus-plugin-content-docs-ex",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/index.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@docusaurus/core": "^3.1.1",
+    "@docusaurus/plugin-content-docs": "^3.1.1",
+    "dayjs": "^1.11.10",
+    "reading-time": "^1.5.0",
+    "simple-git": "^3.22.0"
+  }
+}

packages/docusaurus-plugin-content-docs-ex/src/index.ts

@@ -0,0 +1,106 @@
+import docsPlugin, {
+  PluginOptions,
+  LoadedContent,
+  DocMetadata as OfficialDocMetadata,
+} from "@docusaurus/plugin-content-docs";
+import { Plugin, LoadContext } from "@docusaurus/types";
+import matter from "gray-matter";
+//@ts-ignore
+export { validateOptions } from "@docusaurus/plugin-content-docs/src/index";
+import path from "path";
+import fs from "fs";
+import simpleGit, { DefaultLogFields } from "simple-git";
+import readingTime, { ReadTimeResults } from "reading-time";
+
+export type DocMetadata = OfficialDocMetadata & { detail: Detail };
+
+export interface Detail {
+  filename: string;
+  reading_time: ReadTimeResults;
+  create_date?: Date;
+  update_date?: Date;
+}
+
+export default async function pluginContentDocs(
+  context: LoadContext,
+  options: PluginOptions & { debug?: boolean }
+): Promise<Plugin<LoadedContent>> {
+  const ret = (await docsPlugin.call(
+    this,
+    context,
+    options
+  )) as Plugin<LoadedContent>;
+
+  const themePath = path.resolve(__dirname, "./theme");
+  ret.getThemePath = () => {
+    return themePath;
+  };
+
+  const warpLoadContent = ret.loadContent;
+  ret.loadContent = async () => {
+    const ret = await warpLoadContent();
+    // 注入时间信息
+    const docs: DocMetadata[] = [];
+    const git = simpleGit();
+    ret.loadedVersions.forEach((version) => {
+      version.docs.forEach((doc) => {
+        docs.push(doc as any);
+      });
+    });
+
+    await Promise.all(
+      docs.map(async (doc) => {
+        // 读取文件内容, 查看标题, 查看日期
+        const filename = doc.source.replace("@site", ".");
+        const meta = matter.read(filename);
+        const detail: Detail = {
+          filename: filename,
+          reading_time: readingTime(meta.content),
+        };
+        return new Promise<void>((resolve) => {
+          // 读取git log文件时间
+          git.log<DefaultLogFields>(
+            {
+              format: "%ad",
+              file: filename,
+            },
+            (_, data) => {
+              if (meta.data["create_date"]) {
+                detail.create_date = new Date(meta.data["create_date"]);
+              } else {
+                detail.create_date = data.all.length
+                  ? new Date(data.all[data.all.length - 1].date)
+                  : new Date();
+              }
+              if (meta.data["update_date"]) {
+                detail.update_date = new Date(meta.data["update_date"]);
+              } else {
+                detail.update_date = data.latest
+                  ? new Date(data.latest.date)
+                  : new Date();
+              }
+              doc.detail = detail;
+              resolve();
+            }
+          );
+        });
+      })
+    );
+    // 排序创造时间列表
+
+    return ret;
+  };
+
+  const warpContentLoaded = ret.contentLoaded;
+
+  ret.contentLoaded = async ({ content, actions, allContent }) => {
+    const ret = await warpContentLoaded({
+      content,
+      actions,
+      allContent,
+    });
+    return ret;
+  };
+
+  return ret;
+}