@ruan-cat/vitepress-preset-config 0.7.2 → 0.8.0

package/dist/theme.d.mts

@@ -2,36 +2,19 @@ import * as vue from 'vue';
 import { EnhanceAppContext } from 'vitepress';
 
 /**
- * 一个回调函数 用来暴露变量 实现注册\
- * @deprecated
+ * 一个回调函数 用来暴露变量 实现注册
  */
 interface EnhanceAppCallBack {
     ({ app, router, siteData }: EnhanceAppContext): void;
 }
 /**
- * @deprecated
  */
 interface DefineRuancatPresetThemeParams {
     enhanceAppCallBack?: EnhanceAppCallBack;
 }
-/**
- * 定义默认主题预设
- * @deprecated
- */
-declare function defineRuancatPresetTheme(params?: DefineRuancatPresetThemeParams): {
-    extends: {
-        Layout: vue.DefineComponent;
-        enhanceApp: (ctx: EnhanceAppContext) => void;
-    };
-    Layout: () => vue.VNode<vue.RendererNode, vue.RendererElement, {
-        [key: string]: any;
-    }>;
-    enhanceApp({ app, router, siteData }: EnhanceAppContext): void;
-};
 /**
  * 默认布局配置
  * @description
- * 有疑惑 经过测试 该写法会导致找不到主题文件
  */
 declare const defaultLayoutConfig: {
     "doc-before": () => vue.VNode<vue.RendererNode, vue.RendererElement, {
@@ -50,7 +33,8 @@ declare const defaultLayoutConfig: {
 /**
  * 默认 enhanceApp 预设
  * @description
- * 有疑惑 经过测试 该写法会导致找不到主题文件
+ * 这个函数预期应该作为一个内部函数 不应该对外暴露使用
+ * @private
  */
 declare function defaultEnhanceAppPreset({ app, router, siteData }: EnhanceAppContext): void;
 /** 默认主题配置 */
@@ -65,15 +49,17 @@ declare const defaultTheme: {
     enhanceApp({ app, router, siteData }: EnhanceAppContext): void;
 };
 /**
- * 默认主题配置2
- * @description
- * 从 @sugarat/theme 内学习的配置写法
+ * 定义默认主题预设
  */
-declare const defaultTheme2: {
+declare function defineRuancatPresetTheme(params?: DefineRuancatPresetThemeParams): {
+    enhanceApp({ app, router, siteData }: EnhanceAppContext): void;
+    extends: {
+        Layout: vue.DefineComponent;
+        enhanceApp: (ctx: EnhanceAppContext) => void;
+    };
     Layout: () => vue.VNode<vue.RendererNode, vue.RendererElement, {
         [key: string]: any;
     }>;
-    enhanceApp(ctx: EnhanceAppContext): void;
 };
 
-export { type DefineRuancatPresetThemeParams, type EnhanceAppCallBack, defaultEnhanceAppPreset, defaultLayoutConfig, defaultTheme, defaultTheme2, defineRuancatPresetTheme };
+export { type DefineRuancatPresetThemeParams, type EnhanceAppCallBack, defaultEnhanceAppPreset, defaultLayoutConfig, defaultTheme, defineRuancatPresetTheme };

package/dist/theme.mjs

@@ -11,38 +11,6 @@ import {
 import { NolebaseHighlightTargetedHeading } from "@nolebase/vitepress-plugin-highlight-targeted-heading/client";
 import { NolebaseGitChangelogPlugin } from "@nolebase/vitepress-plugin-git-changelog/client";
 import TwoslashFloatingVue from "@shikijs/vitepress-twoslash/client";
-function defineRuancatPresetTheme(params) {
-  return {
-    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 }) {
-      var _a;
-      app.use(NolebaseGitChangelogPlugin);
-      app.use(TwoslashFloatingVue);
-      app.provide(InjectionKey, {
-        layoutSwitch: {
-          defaultMode: LayoutMode["BothWidthAdjustable"],
-          pageLayoutMaxWidth: {
-            defaultMaxWidth: 85
-          },
-          contentLayoutMaxWidth: {
-            defaultMaxWidth: 95
-          }
-        }
-      });
-      (_a = params == null ? void 0 : params.enhanceAppCallBack) == null ? void 0 : _a.call(params, { app, router, siteData });
-    }
-  };
-}
 var defaultLayoutConfig = {
   // https://vitepress.dev/guide/extending-default-theme#layout-slots
   "doc-before": () => h(NolebaseBreadcrumbs),
@@ -75,39 +43,19 @@ var defaultTheme = {
     defaultEnhanceAppPreset({ app, router, siteData });
   }
 };
-var defaultTheme2 = {
-  ...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(ctx) {
-    DefaultTheme.enhanceApp(ctx);
-    ctx.app.use(NolebaseGitChangelogPlugin);
-    ctx.app.use(TwoslashFloatingVue);
-    ctx.app.provide(InjectionKey, {
-      layoutSwitch: {
-        defaultMode: LayoutMode["BothWidthAdjustable"],
-        pageLayoutMaxWidth: {
-          defaultMaxWidth: 85
-        },
-        contentLayoutMaxWidth: {
-          defaultMaxWidth: 95
-        }
-      }
-    });
-  }
-};
+function defineRuancatPresetTheme(params) {
+  return {
+    ...defaultTheme,
+    enhanceApp({ app, router, siteData }) {
+      var _a;
+      defaultTheme.enhanceApp({ app, router, siteData });
+      (_a = params == null ? void 0 : params.enhanceAppCallBack) == null ? void 0 : _a.call(params, { app, router, siteData });
+    }
+  };
+}
 export {
   defaultEnhanceAppPreset,
   defaultLayoutConfig,
   defaultTheme,
-  defaultTheme2,
   defineRuancatPresetTheme
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
   "homepage": "https://vitepress-preset.ruancat6312.top",
   "types": "./src/config.mts",
@@ -54,7 +54,7 @@
       "types": "./src/config.mts"
     },
     "./theme": {
-      "import": "./dist/theme.mjs",
+      "import": "./src/theme.ts",
       "types": "./src/theme.ts"
     },
     "./theme.css": "./dist/theme.css",

package/src/.vitepress/config.mts

@@ -1,7 +1,7 @@
 // 避免直接使用自己的包
 // import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "@ruan-cat/vitepress-preset-config/config";
 // @ts-ignore
-import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "../../src/config.mts";
+import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "../config.mts";
 import { description } from "../../package.json";
 
 addChangelog2doc({

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

@@ -1,18 +1,9 @@
-// https://vitepress.dev/guide/custom-theme
-import { h } from "vue";
-import type { Theme, EnhanceAppContext } from "vitepress";
-import DefaultTheme from "vitepress/theme";
-import { defaultLayoutConfig, defaultEnhanceAppPreset } from "@ruan-cat/vitepress-preset-config/theme";
+import { defineRuancatPresetTheme } from "@ruan-cat/vitepress-preset-config/theme";
 
 // 导入全部的主题样式
 import "@ruan-cat/vitepress-preset-config/theme.css";
+
+// 增加用户自定义样式
 import "./style.css";
-export default {
-	extends: DefaultTheme,
-	Layout: () => {
-		return h(DefaultTheme.Layout, null, defaultLayoutConfig);
-	},
-	enhanceApp({ app, router, siteData }: EnhanceAppContext) {
-		defaultEnhanceAppPreset({ app, router, siteData });
-	},
-} satisfies Theme;
+
+export default defineRuancatPresetTheme();

package/src/theme.ts

@@ -15,7 +15,6 @@ import { NolebaseBreadcrumbs } from "@nolebase/vitepress-plugin-breadcrumbs/clie
 import {
 	NolebaseEnhancedReadabilitiesMenu,
 	NolebaseEnhancedReadabilitiesScreenMenu,
-
 	// https://nolebase-integrations.ayaka.io/pages/zh-CN/integrations/vitepress-plugin-enhanced-readabilities/#如何在-vitepress-中进行配置
 	InjectionKey,
 	type Options,
@@ -33,68 +32,21 @@ import TwoslashFloatingVue from "@shikijs/vitepress-twoslash/client";
 // import "@shikijs/vitepress-twoslash/style.css";
 
 /**
- * 一个回调函数 用来暴露变量 实现注册\
- * @deprecated
+ * 一个回调函数 用来暴露变量 实现注册
  */
 export interface EnhanceAppCallBack {
 	({ app, router, siteData }: EnhanceAppContext): void;
 }
 
 /**
- * @deprecated
  */
 export interface DefineRuancatPresetThemeParams {
 	enhanceAppCallBack?: EnhanceAppCallBack;
 }
 
-/**
- * 定义默认主题预设
- * @deprecated
- */
-export function defineRuancatPresetTheme(params?: DefineRuancatPresetThemeParams) {
-	return {
-		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 }: EnhanceAppContext) {
-			app.use(NolebaseGitChangelogPlugin);
-			app.use(TwoslashFloatingVue);
-			app.provide(InjectionKey, {
-				layoutSwitch: {
-					defaultMode: LayoutMode["BothWidthAdjustable"],
-					pageLayoutMaxWidth: {
-						defaultMaxWidth: 85,
-					},
-					contentLayoutMaxWidth: {
-						defaultMaxWidth: 95,
-					},
-				},
-			} as Options);
-
-			/**
-			 * 放弃全局注册demo展示组件
-			 * 在生产环境内使用peer对等依赖
-			 */
-			// app.component("VitepressDemoBox", VitepressDemoBox);
-			// app.component("VitepressDemoPlaceholder", VitepressDemoPlaceholder);
-
-			params?.enhanceAppCallBack?.({ app, router, siteData });
-		},
-	} satisfies Theme;
-}
-
 /**
  * 默认布局配置
  * @description
- * 有疑惑 经过测试 该写法会导致找不到主题文件
  */
 export const defaultLayoutConfig = {
 	// https://vitepress.dev/guide/extending-default-theme#layout-slots
@@ -108,7 +60,8 @@ export const defaultLayoutConfig = {
 /**
  * 默认 enhanceApp 预设
  * @description
- * 有疑惑 经过测试 该写法会导致找不到主题文件
+ * 这个函数预期应该作为一个内部函数 不应该对外暴露使用
+ * @private
  */
 export function defaultEnhanceAppPreset({ app, router, siteData }: EnhanceAppContext) {
 	app.use(NolebaseGitChangelogPlugin);
@@ -124,6 +77,12 @@ export function defaultEnhanceAppPreset({ app, router, siteData }: EnhanceAppCon
 			},
 		},
 	} as Options);
+	/**
+	 * 放弃全局注册demo展示组件
+	 * 在生产环境内使用peer对等依赖
+	 */
+	// app.component("VitepressDemoBox", VitepressDemoBox);
+	// app.component("VitepressDemoPlaceholder", VitepressDemoPlaceholder);
 }
 
 /** 默认主题配置 */
@@ -134,47 +93,20 @@ export const defaultTheme = {
 	},
 	enhanceApp({ app, router, siteData }: EnhanceAppContext) {
 		defaultEnhanceAppPreset({ app, router, siteData });
-		/**
-		 * 放弃全局注册demo展示组件
-		 * 在生产环境内使用peer对等依赖
-		 */
-		// app.component("VitepressDemoBox", VitepressDemoBox);
-		// app.component("VitepressDemoPlaceholder", VitepressDemoPlaceholder);
 	},
 } satisfies Theme;
 
 /**
- * 默认主题配置2
- * @description
- * 从 @sugarat/theme 内学习的配置写法
+ * 定义默认主题预设
  */
-export const defaultTheme2 = {
-	...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(ctx: EnhanceAppContext) {
-		DefaultTheme.enhanceApp(ctx);
-
-		ctx.app.use(NolebaseGitChangelogPlugin);
-		ctx.app.use(TwoslashFloatingVue);
-		ctx.app.provide(InjectionKey, {
-			layoutSwitch: {
-				defaultMode: LayoutMode["BothWidthAdjustable"],
-				pageLayoutMaxWidth: {
-					defaultMaxWidth: 85,
-				},
-				contentLayoutMaxWidth: {
-					defaultMaxWidth: 95,
-				},
-			},
-		} as Options);
-	},
-} satisfies Theme;
+export function defineRuancatPresetTheme(params?: DefineRuancatPresetThemeParams) {
+	return {
+		...defaultTheme,
+		enhanceApp({ app, router, siteData }: EnhanceAppContext) {
+			// 回调默认主题内的函数
+			defaultTheme.enhanceApp({ app, router, siteData });
+			// 执行用户传入的回调函数
+			params?.enhanceAppCallBack?.({ app, router, siteData });
+		},
+	} satisfies Theme;
+}