feat(docs): add docs and restructure

2023-12-28 00:06:32 +08:00
parent afc67bc0b9
commit 498374195d
56 changed files with 3751 additions and 54 deletions
@@ -0,0 +1,137 @@
+import { slugifyWithCounter } from "@sindresorhus/slugify";
+import glob from "fast-glob";
+import * as fs from "fs";
+import { toString } from "mdast-util-to-string";
+import * as path from "path";
+import { remark } from "remark";
+import remarkMdx from "remark-mdx";
+import { createLoader } from "simple-functional-loader";
+import { filter } from "unist-util-filter";
+import { SKIP, visit } from "unist-util-visit";
+import * as url from "url";
+
+const __filename = url.fileURLToPath(import.meta.url);
+const processor = remark().use(remarkMdx).use(extractSections);
+const slugify = slugifyWithCounter();
+
+function isObjectExpression(node) {
+  return (
+    node.type === "mdxTextExpression" &&
+    node.data?.estree?.body?.[0]?.expression?.type === "ObjectExpression"
+  );
+}
+
+function excludeObjectExpressions(tree) {
+  return filter(tree, (node) => !isObjectExpression(node));
+}
+
+function extractSections() {
+  return (tree, { sections }) => {
+    slugify.reset();
+
+    visit(tree, (node) => {
+      if (node.type === "heading" || node.type === "paragraph") {
+        let content = toString(excludeObjectExpressions(node));
+        if (node.type === "heading" && node.depth <= 2) {
+          let hash = node.depth === 1 ? null : slugify(content);
+          sections.push([content, hash, []]);
+        } else {
+          sections.at(-1)?.[2].push(content);
+        }
+        return SKIP;
+      }
+    });
+  };
+}
+
+export default function (nextConfig = {}) {
+  let cache = new Map();
+
+  return Object.assign({}, nextConfig, {
+    webpack(config, options) {
+      config.module.rules.push({
+        test: __filename,
+        use: [
+          createLoader(function () {
+            let appDir = path.resolve("./src/app/(docs)/docs");
+            this.addContextDependency(appDir);
+
+            let files = glob.sync("**/*.mdx", { cwd: appDir });
+            let data = files.map((file) => {
+              let url = `/${file.replace(/(^|\/)page\.mdx$/, "")}`;
+              let mdx = fs.readFileSync(path.join(appDir, file), "utf8");
+
+              let sections = [];
+
+              if (cache.get(file)?.[0] === mdx) {
+                sections = cache.get(file)[1];
+              } else {
+                let vfile = { value: mdx, sections };
+                processor.runSync(processor.parse(vfile), vfile);
+                cache.set(file, [mdx, sections]);
+              }
+
+              url = `/docs/${url}`;
+
+              return { url, sections };
+            });
+
+            // When this file is imported within the application
+            // the following module is loaded:
+            return `
+              import FlexSearch from 'flexsearch'
+
+              let sectionIndex = new FlexSearch.Document({
+                tokenize: 'full',
+                document: {
+                  id: 'url',
+                  index: 'content',
+                  store: ['title', 'pageTitle'],
+                },
+                context: {
+                  resolution: 9,
+                  depth: 2,
+                  bidirectional: true
+                }
+              })
+
+              let data = ${JSON.stringify(data)}
+
+              for (let { url, sections } of data) {
+                for (let [title, hash, content] of sections) {
+                  sectionIndex.add({
+                    url: url + (hash ? ('#' + hash) : ''),
+                    title,
+                    content: [title, ...content].join('\\n'),
+                    pageTitle: hash ? sections[0][0] : undefined,
+                  })
+                }
+              }
+
+              export function search(query, options = {}) {
+                let result = sectionIndex.search(query, {
+                  ...options,
+                  enrich: true,
+                })
+                if (result.length === 0) {
+                  return []
+                }
+                return result[0].result.map((item) => ({
+                  url: item.id,
+                  title: item.doc.title,
+                  pageTitle: item.doc.pageTitle,
+                }))
+              }
+            `;
+          }),
+        ],
+      });
+
+      if (typeof nextConfig.webpack === "function") {
+        return nextConfig.webpack(config, options);
+      }
+
+      return config;
+    },
+  });
+}