@ruan-cat/vitepress-preset-config 0.0.1

package/dist/config.d.mts

@@ -0,0 +1,16 @@
+import * as vitepress_sidebar_types from 'vitepress-sidebar/types';
+import { UserConfig, DefaultTheme } from 'vitepress';
+export { defineConfig } from 'vitepress';
+import { generateSidebar } from 'vitepress-sidebar';
+export { addChangelog2doc } from '@ruan-cat/utils/node-esm';
+
+/**
+ * 设置自动生成侧边栏的配置
+ * @see https://vitepress-sidebar.cdget.com/zhHans/guide/options
+ */
+declare function setGenerateSidebar(options?: VitePressSidebarOptions): vitepress_sidebar_types.Sidebar;
+/** 设置vitepress主配置 */
+declare function setUserConfig(config?: UserConfig<DefaultTheme.Config>): UserConfig<DefaultTheme.Config>;
+type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
+
+export { setGenerateSidebar, setUserConfig };

package/dist/config.mjs

@@ -0,0 +1,114 @@
+// src/config.mts
+import { defineConfig } from "vitepress";
+import { generateSidebar } from "vitepress-sidebar";
+import { GitChangelog, GitChangelogMarkdownSection } from "@nolebase/vitepress-plugin-git-changelog/vite";
+import { vitepressDemoPlugin } from "vitepress-demo-plugin";
+import { merge, isUndefined, cloneDeep } from "lodash-es";
+import { addChangelog2doc } from "@ruan-cat/utils/node-esm";
+var defaultSidebarOptions = {
+  // documentRootPath: "src",
+  // 侧边栏需要折叠
+  collapsed: true,
+  // 不需要配置折叠嵌套深度
+  // collapseDepth: 4,
+  // 不需要索引首页 首页直接在标题内找到即可
+  // includeRootIndexFile: true,
+  // 不需要索引文件夹
+  // includeFolderIndexFile: true,
+  // 用文件的 h1 标题作为侧边栏标题
+  useTitleFromFileHeading: true,
+  // 用index文件的标题作为折叠栏的标题
+  useFolderTitleFromIndexFile: true,
+  // 折叠栏链接到index文件
+  useFolderLinkFromIndexFile: true,
+  // 用order字段做菜单排序
+  sortMenusByFrontmatterOrder: true,
+  // 不使用倒序排序
+  // sortMenusOrderByDescending: true,
+  sortMenusByName: false,
+  useFolderLinkFromSameNameSubFile: true,
+  debugPrint: true
+};
+function getMergeSidebarOptions(options) {
+  return merge({}, cloneDeep(defaultSidebarOptions), isUndefined(options) ? {} : options);
+}
+function setGenerateSidebar(options) {
+  return generateSidebar(getMergeSidebarOptions(options));
+}
+var defaultUserConfig = {
+  title: "10wms\u524D\u7AEF\u7EC4\u6280\u672F\u6587\u6863",
+  description: "\u672C\u524D\u7AEF\u9879\u76EE\u5185\u7684\u7EC4\u4EF6\u4F7F\u7528\u3001api\u3001\u7C7B\u578B\u4EE5\u53CA\u4F7F\u7528\u6587\u6863",
+  lang: "zh",
+  // 暂不需要
+  // srcDir: "./src",
+  themeConfig: {
+    i18nRouting: true,
+    search: {
+      provider: "local"
+    },
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: "\u9996\u9875", link: "/" },
+      { text: "\u66F4\u65B0\u65E5\u5FD7", link: "/CHANGELOG.md" }
+      // TODO: 未来项目结束时，在此补充配置
+      // { text: "仓库地址", link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/dev/packages/docs-01-star" },
+    ],
+    outline: {
+      label: "\u672C\u9875\u76EE\u5F55",
+      level: "deep"
+    },
+    // 自动化侧边栏
+    sidebar: setGenerateSidebar(),
+    socialLinks: [
+      {
+        icon: "github",
+        link: "https://github.com/ruan-cat/vercel-monorepo-test/blob/dev/packages/docs-01-star/docs/index.md"
+      }
+    ]
+  },
+  vite: {
+    server: {
+      open: true
+    },
+    plugins: [
+      // @ts-ignore
+      GitChangelog({
+        // 填写在此处填写您的仓库链接
+        repoURL: () => "https://github.com/ruan-cat/vercel-monorepo-test"
+      }),
+      // @ts-ignore
+      GitChangelogMarkdownSection()
+    ],
+    optimizeDeps: {
+      exclude: [
+        "@nolebase/vitepress-plugin-breadcrumbs/client",
+        "@nolebase/vitepress-plugin-enhanced-readabilities/client",
+        "vitepress",
+        "@nolebase/ui"
+      ]
+    },
+    ssr: {
+      noExternal: [
+        // 如果还有别的依赖需要添加的话，并排填写和配置到这里即可
+        "@nolebase/vitepress-plugin-breadcrumbs",
+        "@nolebase/vitepress-plugin-enhanced-readabilities",
+        "@nolebase/ui",
+        "@nolebase/vitepress-plugin-highlight-targeted-heading"
+      ]
+    }
+  },
+  markdown: {
+    config(md) {
+      md.use(vitepressDemoPlugin);
+    }
+  }
+};
+function setUserConfig(config) {
+  return merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
+}
+export {
+  addChangelog2doc,
+  defineConfig,
+  setGenerateSidebar,
+  setUserConfig
+};

package/dist/theme/index.css

@@ -0,0 +1,63 @@
+/* src/.vitepress/theme/style.css */
+:root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe 30%, #41d1ff);
+  --vp-home-hero-image-background-image:
+    linear-gradient(
+      -45deg,
+      #bd34fe 50%,
+      #47caff 50%);
+  --vp-home-hero-image-filter: blur(44px);
+}
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}

package/dist/theme/index.d.mts

@@ -0,0 +1,15 @@
+import * as vitepress from 'vitepress';
+import * as vue from 'vue';
+
+declare const theme: {
+    extends: {
+        Layout: vue.DefineComponent;
+        enhanceApp: (ctx: vitepress.EnhanceAppContext) => void;
+    };
+    Layout: () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+        [key: string]: any;
+    }>;
+    enhanceApp({ app, router, siteData }: vitepress.EnhanceAppContext): void;
+};
+
+export { theme as default };

package/dist/theme/index.mjs

@@ -0,0 +1,46 @@
+// src/.vitepress/theme/index.ts
+import { h } from "vue";
+import DefaultTheme from "vitepress/theme";
+import { NolebaseBreadcrumbs } from "@nolebase/vitepress-plugin-breadcrumbs/client";
+import {
+  NolebaseEnhancedReadabilitiesMenu,
+  NolebaseEnhancedReadabilitiesScreenMenu,
+  InjectionKey,
+  LayoutMode
+} from "@nolebase/vitepress-plugin-enhanced-readabilities/client";
+import "@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css";
+import { NolebaseHighlightTargetedHeading } from "@nolebase/vitepress-plugin-highlight-targeted-heading/client";
+import "@nolebase/vitepress-plugin-highlight-targeted-heading/client/style.css";
+import { NolebaseGitChangelogPlugin } from "@nolebase/vitepress-plugin-git-changelog/client";
+import "@nolebase/vitepress-plugin-git-changelog/client/style.css";
+var theme = {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+      "doc-before": () => h(NolebaseBreadcrumbs),
+      "nav-bar-content-after": () => h(NolebaseEnhancedReadabilitiesMenu),
+      // 为较窄的屏幕（通常是小于 iPad Mini）添加阅读增强菜单
+      "nav-screen-content-after": () => h(NolebaseEnhancedReadabilitiesScreenMenu),
+      "layout-top": () => [h(NolebaseHighlightTargetedHeading)]
+    });
+  },
+  enhanceApp({ app, router, siteData }) {
+    app.use(NolebaseGitChangelogPlugin);
+    app.provide(InjectionKey, {
+      layoutSwitch: {
+        defaultMode: LayoutMode["BothWidthAdjustable"],
+        pageLayoutMaxWidth: {
+          defaultMaxWidth: 85
+        },
+        contentLayoutMaxWidth: {
+          defaultMaxWidth: 95
+        }
+      }
+    });
+  }
+};
+var index_default = theme;
+export {
+  index_default as default
+};

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@ruan-cat/vitepress-preset-config",
+  "version": "0.0.1",
+  "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
+  "homepage": "https://utils.ruancat6312.top",
+  "types": "./src/config.mts",
+  "main": "./src/config.mts",
+  "dependencies": {
+    "@nolebase/vitepress-plugin-breadcrumbs": "^2.15.1",
+    "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.15.1",
+    "@nolebase/vitepress-plugin-git-changelog": "^2.15.1",
+    "@nolebase/vitepress-plugin-highlight-targeted-heading": "^2.15.1",
+    "js-yaml": "^4.1.0",
+    "lodash-es": "^4.17.21",
+    "vitepress-demo-plugin": "^1.3.1",
+    "vitepress-sidebar": "^1.31.1",
+    "vue": "^3.5.13",
+    "@ruan-cat/utils": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/lodash-es": "^4.17.12",
+    "tsup": "^8.4.0",
+    "vitepress": "^1.6.3"
+  },
+  "peerDependencies": {
+    "vitepress": "^1.6.x"
+  },
+  "peerDependenciesMeta": {
+    "vitepress": {
+      "optional": true
+    }
+  },
+  "bugs": {
+    "url": "https://github.com/ruan-cat/vercel-monorepo-test/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ruan-cat/vercel-monorepo-test.git",
+    "directory": "packages/vitepress-preset-config"
+  },
+  "exports": {
+    "./config": {
+      "import": "./dist/config.mjs",
+      "types": "./src/config.mts"
+    },
+    "./theme": {
+      "import": "./dist/theme/index.mjs",
+      "types": "./src/.vitepress/theme/index.ts"
+    }
+  },
+  "keywords": [
+    "vitepress"
+  ],
+  "author": {
+    "name": "ruan-cat",
+    "email": "1219043956@qq.com",
+    "url": "https://github.com/ruan-cat"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/",
+    "tag": "beta"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*",
+        "./*"
+      ]
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/tests",
+    "!src/**/tests",
+    "!src/**/*.md",
+    "!src/.vitepress/cache"
+  ],
+  "scripts": {
+    "docs:dev": "vitepress dev src --port 8080",
+    "do-build-docs": "vitepress build src",
+    "build:docs": "turbo do-build-docs",
+    "do-build": "tsup",
+    "build": "turbo do-build"
+  }
+}

package/src/.vitepress/config.mts

@@ -0,0 +1,21 @@
+// 避免直接使用自己的包
+// import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "@ruan-cat/vitepress-preset-config/config";
+// @ts-ignore
+import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "../../src/config.mts";
+
+addChangelog2doc({
+	target: "./src",
+	data: {
+		order: 1000,
+	},
+});
+
+/**
+ * 本文档的渲染配置
+ */
+const thisDocUserConfig = setUserConfig();
+// @ts-ignore
+thisDocUserConfig.themeConfig.sidebar = setGenerateSidebar({
+	documentRootPath: "./src",
+});
+export default thisDocUserConfig;

package/src/.vitepress/theme/index.ts

@@ -0,0 +1,59 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from "vue";
+import type { Theme } from "vitepress";
+import DefaultTheme from "vitepress/theme";
+import "./style.css";
+
+import { NolebaseBreadcrumbs } from "@nolebase/vitepress-plugin-breadcrumbs/client";
+
+import {
+	NolebaseEnhancedReadabilitiesMenu,
+	NolebaseEnhancedReadabilitiesScreenMenu,
+
+	// https://nolebase-integrations.ayaka.io/pages/zh-CN/integrations/vitepress-plugin-enhanced-readabilities/#如何在-vitepress-中进行配置
+	InjectionKey,
+	type Options,
+	LayoutMode,
+} from "@nolebase/vitepress-plugin-enhanced-readabilities/client";
+import "@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css";
+
+import { NolebaseHighlightTargetedHeading } from "@nolebase/vitepress-plugin-highlight-targeted-heading/client";
+import "@nolebase/vitepress-plugin-highlight-targeted-heading/client/style.css";
+
+import { NolebaseGitChangelogPlugin } from "@nolebase/vitepress-plugin-git-changelog/client";
+import "@nolebase/vitepress-plugin-git-changelog/client/style.css";
+
+const theme = {
+	extends: DefaultTheme,
+	Layout: () => {
+		return h(DefaultTheme.Layout, null, {
+			// https://vitepress.dev/guide/extending-default-theme#layout-slots
+
+			"doc-before": () => h(NolebaseBreadcrumbs),
+
+			"nav-bar-content-after": () => h(NolebaseEnhancedReadabilitiesMenu),
+			// 为较窄的屏幕（通常是小于 iPad Mini）添加阅读增强菜单
+			"nav-screen-content-after": () => h(NolebaseEnhancedReadabilitiesScreenMenu),
+
+			"layout-top": () => [h(NolebaseHighlightTargetedHeading)],
+		});
+	},
+	enhanceApp({ app, router, siteData }) {
+		// ...
+		app.use(NolebaseGitChangelogPlugin);
+
+		app.provide(InjectionKey, {
+			layoutSwitch: {
+				defaultMode: LayoutMode["BothWidthAdjustable"],
+				pageLayoutMaxWidth: {
+					defaultMaxWidth: 85,
+				},
+				contentLayoutMaxWidth: {
+					defaultMaxWidth: 95,
+				},
+			},
+		} as Options);
+	},
+} satisfies Theme;
+
+export default theme;

package/src/.vitepress/theme/style.css

@@ -0,0 +1,130 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ * 
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+:root {
+	--vp-c-default-1: var(--vp-c-gray-1);
+	--vp-c-default-2: var(--vp-c-gray-2);
+	--vp-c-default-3: var(--vp-c-gray-3);
+	--vp-c-default-soft: var(--vp-c-gray-soft);
+
+	--vp-c-brand-1: var(--vp-c-indigo-1);
+	--vp-c-brand-2: var(--vp-c-indigo-2);
+	--vp-c-brand-3: var(--vp-c-indigo-3);
+	--vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+	--vp-c-tip-1: var(--vp-c-brand-1);
+	--vp-c-tip-2: var(--vp-c-brand-2);
+	--vp-c-tip-3: var(--vp-c-brand-3);
+	--vp-c-tip-soft: var(--vp-c-brand-soft);
+
+	--vp-c-warning-1: var(--vp-c-yellow-1);
+	--vp-c-warning-2: var(--vp-c-yellow-2);
+	--vp-c-warning-3: var(--vp-c-yellow-3);
+	--vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+	--vp-c-danger-1: var(--vp-c-red-1);
+	--vp-c-danger-2: var(--vp-c-red-2);
+	--vp-c-danger-3: var(--vp-c-red-3);
+	--vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+	--vp-button-brand-border: transparent;
+	--vp-button-brand-text: var(--vp-c-white);
+	--vp-button-brand-bg: var(--vp-c-brand-3);
+	--vp-button-brand-hover-border: transparent;
+	--vp-button-brand-hover-text: var(--vp-c-white);
+	--vp-button-brand-hover-bg: var(--vp-c-brand-2);
+	--vp-button-brand-active-border: transparent;
+	--vp-button-brand-active-text: var(--vp-c-white);
+	--vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+	--vp-home-hero-name-color: transparent;
+	--vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe 30%, #41d1ff);
+
+	--vp-home-hero-image-background-image: linear-gradient(-45deg, #bd34fe 50%, #47caff 50%);
+	--vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+	:root {
+		--vp-home-hero-image-filter: blur(56px);
+	}
+}
+
+@media (min-width: 960px) {
+	:root {
+		--vp-home-hero-image-filter: blur(68px);
+	}
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+	--vp-custom-block-tip-border: transparent;
+	--vp-custom-block-tip-text: var(--vp-c-text-1);
+	--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+	--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+	--docsearch-primary-color: var(--vp-c-brand-1) !important;
+}

package/src/config.mts

@@ -0,0 +1,157 @@
+import { defineConfig, type DefaultTheme, type UserConfig } from "vitepress";
+import { generateSidebar, withSidebar } from "vitepress-sidebar";
+
+export { defineConfig };
+
+import { GitChangelog, GitChangelogMarkdownSection } from "@nolebase/vitepress-plugin-git-changelog/vite";
+import { vitepressDemoPlugin } from "vitepress-demo-plugin";
+
+import { merge, isUndefined, cloneDeep } from "lodash-es";
+
+import { addChangelog2doc } from "@ruan-cat/utils/node-esm";
+export { addChangelog2doc };
+
+/** 默认侧边栏配置 */
+const defaultSidebarOptions: VitePressSidebarOptions = {
+	// documentRootPath: "src",
+
+	// 侧边栏需要折叠
+	collapsed: true,
+
+	// 不需要配置折叠嵌套深度
+	// collapseDepth: 4,
+
+	// 不需要索引首页 首页直接在标题内找到即可
+	// includeRootIndexFile: true,
+
+	// 不需要索引文件夹
+	// includeFolderIndexFile: true,
+
+	// 用文件的 h1 标题作为侧边栏标题
+	useTitleFromFileHeading: true,
+
+	// 用index文件的标题作为折叠栏的标题
+	useFolderTitleFromIndexFile: true,
+
+	// 折叠栏链接到index文件
+	useFolderLinkFromIndexFile: true,
+
+	// 用order字段做菜单排序
+	sortMenusByFrontmatterOrder: true,
+
+	// 不使用倒序排序
+	// sortMenusOrderByDescending: true,
+	sortMenusByName: false,
+
+	useFolderLinkFromSameNameSubFile: true,
+
+	debugPrint: true,
+};
+
+/** 获得合并后的侧边栏配置 */
+function getMergeSidebarOptions(options?: VitePressSidebarOptions) {
+	return merge({}, cloneDeep(defaultSidebarOptions), isUndefined(options) ? {} : options);
+}
+
+/**
+ * 设置自动生成侧边栏的配置
+ * @see https://vitepress-sidebar.cdget.com/zhHans/guide/options
+ */
+export function setGenerateSidebar(options?: VitePressSidebarOptions) {
+	return generateSidebar(getMergeSidebarOptions(options));
+}
+
+/** 默认用户配置 */
+const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
+	title: "10wms前端组技术文档",
+	description: "本前端项目内的组件使用、api、类型以及使用文档",
+
+	lang: "zh",
+	// 暂不需要
+	// srcDir: "./src",
+
+	themeConfig: {
+		i18nRouting: true,
+
+		search: {
+			provider: "local",
+		},
+
+		// https://vitepress.dev/reference/default-theme-config
+		nav: [
+			{ text: "首页", link: "/" },
+			{ text: "更新日志", link: "/CHANGELOG.md" },
+			// TODO: 未来项目结束时，在此补充配置
+			// { text: "仓库地址", link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/dev/packages/docs-01-star" },
+		],
+
+		outline: {
+			label: "本页目录",
+			level: "deep",
+		},
+
+		// 自动化侧边栏
+		sidebar: setGenerateSidebar(),
+
+		socialLinks: [
+			{
+				icon: "github",
+				link: "https://github.com/ruan-cat/vercel-monorepo-test/blob/dev/packages/docs-01-star/docs/index.md",
+			},
+		],
+	},
+
+	vite: {
+		server: {
+			open: true,
+		},
+
+		plugins: [
+			// @ts-ignore
+			GitChangelog({
+				// 填写在此处填写您的仓库链接
+				repoURL: () => "https://github.com/ruan-cat/vercel-monorepo-test",
+			}),
+			// @ts-ignore
+			GitChangelogMarkdownSection(),
+		],
+
+		optimizeDeps: {
+			exclude: [
+				"@nolebase/vitepress-plugin-breadcrumbs/client",
+				"@nolebase/vitepress-plugin-enhanced-readabilities/client",
+				"vitepress",
+				"@nolebase/ui",
+			],
+		},
+
+		ssr: {
+			noExternal: [
+				// 如果还有别的依赖需要添加的话，并排填写和配置到这里即可
+				"@nolebase/vitepress-plugin-breadcrumbs",
+
+				"@nolebase/vitepress-plugin-enhanced-readabilities",
+				"@nolebase/ui",
+
+				"@nolebase/vitepress-plugin-highlight-targeted-heading",
+			],
+		},
+	},
+
+	markdown: {
+		config(md) {
+			md.use(vitepressDemoPlugin);
+		},
+	},
+};
+
+/** 设置vitepress主配置 */
+export function setUserConfig(config?: UserConfig<DefaultTheme.Config>) {
+	return merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
+}
+
+type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
+
+// TODO:
+/** 设置导航栏的变更日志 */
+function handleChangeLog() {}