feat: awesome

.gitignore

@@ -16,5 +16,4 @@ node_modules
 pnpm-global
 TODOs.md
 *.timestamp-*.mjs
-.env
-pages/
+.env

.vitepress/config.mts

@@ -16,13 +16,11 @@ import path from "node:path";
 import { exec } from "child_process";
 import { buildSideBar } from "../utils/sideBar";
 
-import inject from '@rollup/plugin-inject'
-
 
 const DOC_BASE_PATH = "pages";
 
 if (process.env.NODE_ENV === "production") {
-  // 执行清理pages命令
+  // 执行清理pages文件夹命令
   await new Promise((resolve, reject) =>
     exec(
       `git checkout -- ${DOC_BASE_PATH} & git clean -df ${DOC_BASE_PATH}`,
@@ -75,15 +73,32 @@ await Promise.all(
 );
 
 // 构建sideBar数据
-// TODO
-const sideBarSortMap = {}
-let { rootSideBar, zhHKSideBar } = buildSideBar(contents);
+function readJsonFile(filePath) {
+  try {
+      // 同步读取文件内容，如果文件不存在会抛出异常
+      const data = fs.readFileSync(filePath, 'utf8');
+      return JSON.parse(data); // 解析 JSON 数据
+  } catch (err) {
+      if (err.code === 'ENOENT') {
+          console.error('File not found:', filePath);
+          // 可以返回默认值或者进行其他处理
+          return {}; // 返回 null 或者其他默认值
+      } else {
+          throw err; // 抛出其他异常
+      }
+  }
+}
+const sideBarSortMap = {
+  'zh-CN': readJsonFile('pages/zh-CN::SIDEBAR_SORTED_MAP.json'),
+  'zh-HK': readJsonFile('pages/zh-HK::SIDEBAR_SORTED_MAP.json'),
+  'en-US': readJsonFile('pages/en-US::SIDEBAR_SORTED_MAP.json'),
+}
+let { rootSideBar, zhHKSideBar, enUSSideBar } = buildSideBar(contents, sideBarSortMap);
 import util from "util";
 console.log(
+  util.inspect(sideBarSortMap, {showHidden: false, depth: null, colors: true}),
   util.inspect(rootSideBar, { showHidden: false, depth: null, colors: true }),
-  util.inspect(zhHKSideBar, { showHidden: false, depth: null, colors: true })
 );
-// process.exit();
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -100,13 +115,15 @@ export default defineConfig({
   vite: {
     publicDir: "../public",
     envDir: "../",
-    // optimizeDeps: {
-    //   include: ["vue-i18n"],
-    // },
     ssr: {
       // SSG Vue-i18n workaround
       noExternal: [/vue-i18n/],
     },
+    build: {
+      rollupOptions: {
+        external: ['path-browserify'] // 排除特定模块
+      }
+    },
     plugins: [
       VueI18nPlugin({
         /* options */
@@ -168,9 +185,6 @@ export default defineConfig({
           ),
         },
       }),
-      inject({
-        process: 'process/browser'
-      })
     ],
     resolve: {
       alias: [
@@ -199,22 +213,22 @@ export default defineConfig({
         //   { text: 'Home', link: '/' },
         //   { text: 'Examples', link: '/markdown-examples' }
         // ],
-        sidebar: [
-          { text: "关于CocoBlockly X", link: "/docs" },
-          { text: "常见问题解答", link: "/docs/常见问题解答" },
-          {
-            text: "开始使用CocoBlockly X",
-            link: "/docs/start-using-cocoblockly-x",
-            collapsed: true,
-            items: [],
-          },
-          {
-            text: "电子模块基本教学",
-            collapsed: true,
-            items: [{ text: "todo", link: "/docs" }],
-          },
-        ],
-        // sidebar: rootSideBar,
+        // sidebar: [
+        //   { text: "关于CocoBlockly X", link: "/docs" },
+        //   { text: "常见问题解答", link: "/docs/常见问题解答" },
+        //   {
+        //     text: "开始使用CocoBlockly X",
+        //     link: "/docs/start-using-cocoblockly-x",
+        //     collapsed: true,
+        //     items: [],
+        //   },
+        //   {
+        //     text: "电子模块基本教学",
+        //     collapsed: true,
+        //     items: [{ text: "todo", link: "/docs" }],
+        //   },
+        // ],
+        sidebar: rootSideBar,
         // socialLinks: [
         //   { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
         // ]
@@ -231,19 +245,50 @@ export default defineConfig({
         //   { text: 'Home', link: '/' },
         //   { text: 'Examples', link: '/markdown-examples' }
         // ],
-        sidebar: [
-          { text: "什麽是CocoBlockly X", link: "/zh-HK/docs" },
-          { text: "常見問題解答", link: "/zh-HK/docs/faq" },
-          {
-            text: "開始使用CocoBlockly X",
-            link: "/zh-HK/docs/start-using-cocoblockly-x",
-          },
-          {
-            text: "電子模組基本教學",
-            collapsed: true,
-            items: [{ text: "todo", link: "/zh-HK/docs" }],
-          },
-        ],
+        // sidebar: [
+        //   { text: "什麽是CocoBlockly X", link: "/zh-HK/docs" },
+        //   { text: "常見問題解答", link: "/zh-HK/docs/faq" },
+        //   {
+        //     text: "開始使用CocoBlockly X",
+        //     link: "/zh-HK/docs/start-using-cocoblockly-x",
+        //   },
+        //   {
+        //     text: "電子模組基本教學",
+        //     collapsed: true,
+        //     items: [{ text: "todo", link: "/zh-HK/docs" }],
+        //   },
+        // ],
+        sidebar: zhHKSideBar,
+        // socialLinks: [
+        //   { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+        // ]
+      },
+    },
+    "en-US": {
+      label: "English",
+      lang: "en-US",
+      themeConfig: {
+        logo: "/logo.png",
+        siteTitle: false,
+        // https://vitepress.dev/reference/default-theme-config
+        // nav: [
+        //   { text: 'Home', link: '/' },
+        //   { text: 'Examples', link: '/markdown-examples' }
+        // ],
+        // sidebar: [
+        //   { text: "什麽是CocoBlockly X", link: "/zh-HK/docs" },
+        //   { text: "常見問題解答", link: "/zh-HK/docs/faq" },
+        //   {
+        //     text: "開始使用CocoBlockly X",
+        //     link: "/zh-HK/docs/start-using-cocoblockly-x",
+        //   },
+        //   {
+        //     text: "電子模組基本教學",
+        //     collapsed: true,
+        //     items: [{ text: "todo", link: "/zh-HK/docs" }],
+        //   },
+        // ],
+        sidebar: enUSSideBar,
         // socialLinks: [
         //   { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
         // ]

.vitepress/theme/index.ts

@@ -11,6 +11,12 @@ export default {
   extends: DefaultTheme,
   Layout: CustomLayout,
   enhanceApp({ app, router, siteData }) {
+    // NOTE polyfill `process` for library `path-browserify`，@SEE: https://github.com/browserify/path-browserify/issues/34
+    if (!import.meta.env.SSR) {
+      import('process/browser').then((module) => {
+        globalThis.process = module
+      })
+    }
     app.use(i18n);
     app.use(ElementPlus)
     // ...

components/Edit/index.vue

@@ -24,6 +24,7 @@ import type {
   AllowDropType,
   NodeDropType,
 } from "element-plus/es/components/tree/src/tree.type";
+
 import path from "path-browserify";
 
 const s3 = new S3Client({

utils/sideBar.ts

@@ -1,47 +1,69 @@
 import { s3ContentsToTree } from "../utils/s3Helper";
 import _ from "lodash";
 
-const trimPrefix = (str, prefix) => {
-  return str.replace(new RegExp(`^${prefix}`), "docs");
+const trimPrefix = (str, prefix, to) => {
+  return str.replace(prefix, to);
 };
 const trimSuffix = (str) => {
   return str.replace(/.md$/, "");
 };
 
-const filterLocaleContents = (contents, prefix) => {
+const filterLocaleContents = (contents, prefix, sortMap) => {
   return contents!
-    .filter((cont) => new RegExp(`^${prefix}/`).test(cont.Key!))
+    .filter((cont) => cont.Key!.startsWith(prefix))
     .map((cont) => {
       return {
         ...cont,
-        Key: trimSuffix(trimPrefix(cont.Key, prefix)),
+        Key: trimSuffix(trimPrefix(cont.Key, prefix, "")),
+        link: trimSuffix(`/${cont.Key}`),
+        sortKey: trimPrefix(cont.Key, prefix, ""),
       };
-    });
+    })
+    .sort((a, b) => sortMap?.[a.sortKey] - sortMap?.[b.sortKey]);
 };
 
 const sideBarReducer = (r, label, i, a, Content) => {
   const extra = {
     collapsed: a.length !== i + 1,
+    link: Content.link,
   };
   if (a.length === i + 1) {
     extra.items = undefined;
   } else {
-    extra.link = undefined
+    extra.link = undefined;
   }
   return extra;
 };
-export const buildSideBar = (contents) => {
-  const rootContents = filterLocaleContents(contents, "docs");
-  const zhHKContents = filterLocaleContents(contents, "zh-HK/docs");
+export const buildSideBar = (contents, sideBarSortMap) => {
+  const rootContents = filterLocaleContents(
+    contents,
+    "docs/",
+    sideBarSortMap["zh-CN"]
+  );
+  const zhHKContents = filterLocaleContents(
+    contents,
+    "zh-HK/docs/",
+    sideBarSortMap["zh-HK"]
+  );
+  const enUSContents = filterLocaleContents(
+    contents,
+    "en-US/docs/",
+    sideBarSortMap["en-US"]
+  );
   const rootSideBar = s3ContentsToTree(
     rootContents,
-    { key: "link", label: "text", children: "items" },
+    { label: "text", children: "items" },
     sideBarReducer
-  )[0].items;
+  );
   const zhHKSideBar = s3ContentsToTree(
     zhHKContents,
-    { key: "link", label: "text", children: "items" },
+    { label: "text", children: "items" },
     sideBarReducer
-  )[0].items;
-  return { rootSideBar, zhHKSideBar };
+  );
+  const enUSSideBar = s3ContentsToTree(
+    enUSContents,
+    { label: "text", children: "items" },
+    sideBarReducer
+  );
+  return { rootSideBar, zhHKSideBar, enUSSideBar };
 };