fix: 🐛 修复 windows 下 autoSiderBar 插件的路径生成，以及 搜索插件的链接问题

Author: ChandlerVer5

.vitepress/config.ts renamed to .vitepress/config.mts

@@ -2,16 +2,14 @@ import { defineConfig } from "vitepress";
 import { SearchPlugin } from "@ver5/vitepress-plugin-search";
 
 import markIt from "markdown-it-mark";
-import { REPO_URL } from "./const";
+import { REPO_URL, OUT_DIR, BASE_NAME, SRC_DOC } from "./const";
 import nav from "./nav";
-import { books, sidebar, SRC_DOC } from "./sidebar";
+import { books, sidebar } from "./sidebar";
 import { linkPlugin } from "./plugins/linkPlugin";
 import { rustCodePlugin } from "./plugins/rustcode/runCodePlugin";
 import { imageSizePlugin } from "./plugins/imagePlugin";
 import { alignPlugin } from "./plugins/alignPlugin";
 
-const REPO_NAME_BASE = "/rust_study";
-const OUT_DIR = "dist";
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -24,7 +22,7 @@ export default defineConfig({
   ],
   srcDir: SRC_DOC,
   outDir: OUT_DIR,
-  base: REPO_NAME_BASE,
+  base: BASE_NAME,
   vite: {
     plugins: [
       SearchPlugin({
@@ -34,10 +32,10 @@ export default defineConfig({
         allow: [],
         ignore: [],
         tokenize: "forward",
+        separator: ' ', // fix search result link problems
       }),
     ],
   },
-
   lastUpdated: true,
   cleanUrls: false,
   markdown: {

.vitepress/const.ts

@@ -1,2 +1,7 @@
-// 定义常量
+/** 定义常量 */
+
+export const BASE_NAME = "/rust_study";
+export const OUT_DIR = "dist";
+export const SRC_DOC = "docs";
+
 export const REPO_URL = 'https://github.com/ChandlerVer5/rust_study/'

.vitepress/plugins/autoSidebar.ts

@@ -3,12 +3,13 @@
 //
 import merge from 'lodash/merge';
 import sortBy from 'lodash/sortBy';
-import remove from 'lodash/remove';
 import { globbySync } from '@cjs-exporter/globby';
-import { sep, basename, join } from 'node:path';
+import { basename, resolve, join } from 'node:path';
 
 type Sidebar = SidebarGroup[] | SidebarItem;
 
+const sep = '/';
+
 interface SidebarItem {
   text: string
   link: string
@@ -58,24 +59,23 @@ const getDirName = (path: string) => {
 };
 
 // Load all MD files in a specified directory
-const getChildren = function(parentPath: string, options: Options) {
+const getChildren = function (parentPath: string, options: Options) {
   const { indexLink, sortBy: sortFn, ignoreMDFiles, hierarchy } = options
-  const pattern = '/**/*.md';
-  const files = globbySync(join(parentPath, pattern)).map((path) => {
+  const pattern = join('**', '*.md');
+  const files = globbySync(join(parentPath, pattern).replace(/\\/g, sep)).map((path) => {
     // fix parentPath relative dir
-    const newPath = path.slice((new RegExp(`.*?${sep}`)).exec(path)![0].length, -3);
+    const newPath = path.slice(((/.*?\//).exec(path))?.[0].length, -3);
 
     // ignore some files
-    if (ignoreMDFiles?.length && ignoreMDFiles.some((ifile) => newPath.endsWith(ifile))) {
-      return 0;
+    if (ignoreMDFiles?.length && ignoreMDFiles.some((f) => newPath.endsWith(f))) {
+      return { path: '' };
     }
-    if (hierarchy && indexLink === basename(newPath)) return 0;
+    if (hierarchy && indexLink === basename(newPath)) return { path: '' };
     return { path: newPath };
-  });
+  }).filter(file => !!file.path);
 
-  remove(files, file => file === 0);
   // Return the ordered list of files, sort by Options.sortBy or 'path'
-  return sortBy(files, sortFn ? (f) => sortFn(f!.path) : ['path']).map(file => file?.path || '');
+  return sortBy(files, sortFn ? (f) => sortFn(f.path) : ['path']).map(file => file.path || '');
 };
 
 /**
@@ -84,7 +84,7 @@ const getChildren = function(parentPath: string, options: Options) {
   ss.dev/reference/default-theme-sidebar#the-basics
 */
 function normalize(path: string) {
-  return sep + path + '.md'
+  return (sep + path + '.md')
 }
 
 // Return sidebar config for given baseDir.

.vitepress/plugins/linkPlugin.ts

@@ -1,11 +1,11 @@
 import type MarkdownIt from 'markdown-it'
 import { normalizeLink } from './utils'
+import { BASE_NAME } from '../const'
 
 export interface Options {
   books: any[]
 }
 
-
 const link_rules = {
   "RFC 文档|RFC 项目": "https://rust-lang.github.io/rfcs/",
   "RFC 1216": 'https://rust-lang.github.io/rfcs/1216-bang-type.html',
@@ -18,8 +18,9 @@ const getRegRules = (text: string) => [
 ]
 
 function toLinkUrl(raw: string, rule: string, link: string) {
-  return raw.replace(new RegExp(rule, 'g'), (matchText) => `<a href=${normalizeLink(link)}>${matchText}</a>`)
+  return raw.replace(new RegExp(rule, 'g'), (matchText) => `<a href=${normalizeLink(BASE_NAME + link)}>${matchText}</a>`)
 }
+
 /**
 * 将对应的部分、章节进行链接，方便快速跳转。
 */
@@ -42,6 +43,7 @@ export function linkPlugin(md: MarkdownIt, options: Options) {
       })
     }
 
+    // 自定义规则匹配
     Object.keys(link_rules).forEach((ruleKey) => {
       rawText = toLinkUrl(rawText, ruleKey, link_rules[ruleKey])
     })

.vitepress/sidebar.ts

@@ -1,7 +1,6 @@
 import { join } from 'node:path'
 import { getSideBar } from './plugins/autoSidebar'
-
-export const SRC_DOC = "docs";
+import { SRC_DOC } from './const'
 
 export const notes = getSideBar(join(SRC_DOC, 'notes'), {
   hierarchy: false,
@@ -14,7 +13,7 @@ export const codes = getSideBar(join(SRC_DOC, 'codes'), {
 })
 
 export const books = getSideBar(SRC_DOC, {
-  ignoreDirs: ['notes', 'codes'],
+  ignoreDirs: ['notes', 'codes', 'images', 'public'],
   indexLink: 'index',
   ignoreMDFiles: ['index'],
   sortBy: (path) => {

docs/第 5 章 trait/5.7 trait 别名.md

@@ -2,8 +2,6 @@
 
 跟 type alias 类似的，trait 也可以起别名（trait alias）。假如在某些场景下，我们有一个比较复杂的 trait：
 
----
-
 ```rust
 pub trait Service {
     type Request;
@@ -14,16 +12,10 @@ pub trait Service {
 }
 ```
 
----
-
 每次使用这个 trait 的时候都需要携带一堆的关联类型参数。为了避免这样的麻烦，在已经确定了关联类型的场景下，我们可以为它取一个别名，比如：
 
----
-
 ```rust
 trait HttpService = Service<Request = http::Request,
         Response = http::Response,
         Error = http::Error>;
 ```
-
----

package.json

@@ -22,8 +22,8 @@
     "markdown-it-mark": "^3.0.1",
     "sass": "^1.62.1",
     "tslib": "^2.5.2",
-    "vitepress": "1.0.0-beta.1",
-    "vitepress-plugin-search": "1.0.4-alpha.20",
+    "vite": "^5.2.6",
+    "vitepress": "^1.0.1",
     "vue": "^3.3.4"
   }
-}
+}