@ruan-cat/vitepress-preset-config 0.5.0 → 0.7.0

package/dist/config.mjs

@@ -2,7 +2,7 @@
 import { defineConfig } from "vitepress";
 import { generateSidebar } from "vitepress-sidebar";
 import { GitChangelog, GitChangelogMarkdownSection } from "@nolebase/vitepress-plugin-git-changelog/vite";
-import { vitepressDemoPlugin } from "@ruan-cat/vitepress-demo-plugin";
+import { vitepressDemoPlugin } from "vitepress-demo-plugin";
 import { merge, isUndefined, cloneDeep } from "lodash-es";
 import consola from "consola";
 import { addChangelog2doc, hasChangelogMd } from "@ruan-cat/utils/node-esm";

package/dist/theme.css

@@ -1,4 +1,3 @@
-@import "@ruan-cat/vitepress-demo-plugin/dist/index.css";
 @import "@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css";
 @import "@nolebase/vitepress-plugin-highlight-targeted-heading/client/style.css";
 @import "@nolebase/vitepress-plugin-git-changelog/client/style.css";

package/dist/theme.d.mts

@@ -1,14 +1,23 @@
 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;
@@ -19,5 +28,33 @@ declare function defineRuancatPresetTheme(params?: DefineRuancatPresetThemeParam
     }>;
     enhanceApp({ app, router, siteData }: EnhanceAppContext): void;
 };
+/** 默认布局配置 */
+declare const defaultLayoutConfig: {
+    "doc-before": () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+        [key: string]: any;
+    }>;
+    "nav-bar-content-after": () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+        [key: string]: any;
+    }>;
+    "nav-screen-content-after": () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+        [key: string]: any;
+    }>;
+    "layout-top": () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+        [key: string]: any;
+    }>[];
+};
+/** 默认 enhanceApp 预设 */
+declare function defaultEnhanceAppPreset({ app, router, siteData }: EnhanceAppContext): void;
+/** 默认主题配置 */
+declare const defaultTheme: {
+    extends: {
+        Layout: vue.DefineComponent;
+        enhanceApp: (ctx: EnhanceAppContext) => void;
+    };
+    Layout: () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+        [key: string]: any;
+    }>;
+    enhanceApp({ app, router, siteData }: EnhanceAppContext): void;
+};
 
-export { type DefineRuancatPresetThemeParams, type EnhanceAppCallBack, defineRuancatPresetTheme };
+export { type DefineRuancatPresetThemeParams, type EnhanceAppCallBack, defaultEnhanceAppPreset, defaultLayoutConfig, defaultTheme, defineRuancatPresetTheme };

package/dist/theme.mjs

@@ -1,7 +1,6 @@
 // src/theme.ts
 import { h } from "vue";
 import DefaultTheme from "vitepress/theme";
-import { VitepressDemoBox, VitepressDemoPlaceholder } from "@ruan-cat/vitepress-demo-plugin";
 import { NolebaseBreadcrumbs } from "@nolebase/vitepress-plugin-breadcrumbs/client";
 import {
   NolebaseEnhancedReadabilitiesMenu,
@@ -40,12 +39,45 @@ function defineRuancatPresetTheme(params) {
           }
         }
       });
-      app.component("VitepressDemoBox", VitepressDemoBox);
-      app.component("VitepressDemoPlaceholder", VitepressDemoPlaceholder);
       (_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),
+  "nav-bar-content-after": () => h(NolebaseEnhancedReadabilitiesMenu),
+  // 为较窄的屏幕（通常是小于 iPad Mini）添加阅读增强菜单
+  "nav-screen-content-after": () => h(NolebaseEnhancedReadabilitiesScreenMenu),
+  "layout-top": () => [h(NolebaseHighlightTargetedHeading)]
+};
+function defaultEnhanceAppPreset({ app, router, siteData }) {
+  app.use(NolebaseGitChangelogPlugin);
+  app.use(TwoslashFloatingVue);
+  app.provide(InjectionKey, {
+    layoutSwitch: {
+      defaultMode: LayoutMode["BothWidthAdjustable"],
+      pageLayoutMaxWidth: {
+        defaultMaxWidth: 85
+      },
+      contentLayoutMaxWidth: {
+        defaultMaxWidth: 95
+      }
+    }
+  });
+}
+var defaultTheme = {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, defaultLayoutConfig);
+  },
+  enhanceApp({ app, router, siteData }) {
+    defaultEnhanceAppPreset({ app, router, siteData });
+  }
+};
 export {
+  defaultEnhanceAppPreset,
+  defaultLayoutConfig,
+  defaultTheme,
   defineRuancatPresetTheme
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
   "homepage": "https://vitepress-preset.ruancat6312.top",
   "types": "./src/config.mts",
@@ -14,10 +14,10 @@
     "consola": "^3.4.0",
     "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.2.1",
-    "@ruan-cat/vitepress-demo-plugin": "^0.1.0"
+    "@ruan-cat/utils": "^4.2.1"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
@@ -25,11 +25,19 @@
     "vitepress": "^1.6.3"
   },
   "peerDependencies": {
-    "vitepress": "^1.6.x"
+    "vitepress": "^1.6.x",
+    "vitepress-demo-plugin": "^1",
+    "vue": "^3.5.x"
   },
   "peerDependenciesMeta": {
     "vitepress": {
       "optional": true
+    },
+    "vue": {
+      "optional": true
+    },
+    "vitepress-demo-plugin": {
+      "optional": false
     }
   },
   "bugs": {

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

@@ -1,6 +1,18 @@
-import { defineRuancatPresetTheme } from "../../theme";
+// 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 "@ruan-cat/vitepress-preset-config/theme.css";
 import "./style.css";
-
-export default defineRuancatPresetTheme();
+export default {
+	extends: DefaultTheme,
+	Layout: () => {
+		return h(DefaultTheme.Layout, null, defaultLayoutConfig);
+	},
+	enhanceApp({ app, router, siteData }: EnhanceAppContext) {
+		defaultEnhanceAppPreset({ app, router, siteData });
+	},
+} satisfies Theme;

package/src/config.mts

@@ -4,7 +4,7 @@ import { generateSidebar, withSidebar } from "vitepress-sidebar";
 export { defineConfig };
 
 import { GitChangelog, GitChangelogMarkdownSection } from "@nolebase/vitepress-plugin-git-changelog/vite";
-import { vitepressDemoPlugin } from "@ruan-cat/vitepress-demo-plugin";
+import { vitepressDemoPlugin } from "vitepress-demo-plugin";
 
 import { merge, isUndefined, cloneDeep } from "lodash-es";
 import consola from "consola";

package/src/index.css

@@ -1,4 +1,5 @@
-@import "@ruan-cat/vitepress-demo-plugin/dist/index.css";
+/* 放弃二次封装该库 在生产环境内使用peer对等依赖 */
+/* @import "@ruan-cat/vitepress-demo-plugin/dist/index.css"; */
 @import "@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css";
 @import "@nolebase/vitepress-plugin-highlight-targeted-heading/client/style.css";
 @import "@nolebase/vitepress-plugin-git-changelog/client/style.css";

package/src/theme.ts

@@ -6,7 +6,8 @@ import DefaultTheme from "vitepress/theme";
 // 将全部的样式集中在专门的文件内 在tsup内被打包出去
 import "./index.css";
 
-import { VitepressDemoBox, VitepressDemoPlaceholder } from "@ruan-cat/vitepress-demo-plugin";
+// 警告 放弃内部处理该库 直接使用peer对等依赖 不再考虑包装封装该库
+// import { VitepressDemoBox, VitepressDemoPlaceholder } from "@ruan-cat/vitepress-demo-plugin";
 // import "@ruan-cat/vitepress-demo-plugin/dist/index.css";
 
 import { NolebaseBreadcrumbs } from "@nolebase/vitepress-plugin-breadcrumbs/client";
@@ -31,16 +32,25 @@ import { NolebaseGitChangelogPlugin } from "@nolebase/vitepress-plugin-git-chang
 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,
@@ -68,11 +78,59 @@ export function defineRuancatPresetTheme(params?: DefineRuancatPresetThemeParams
 					},
 				},
 			} as Options);
-			// 全局注册demo展示组件
-			app.component("VitepressDemoBox", VitepressDemoBox);
-			app.component("VitepressDemoPlaceholder", VitepressDemoPlaceholder);
+
+			/**
+			 * 放弃全局注册demo展示组件
+			 * 在生产环境内使用peer对等依赖
+			 */
+			// app.component("VitepressDemoBox", VitepressDemoBox);
+			// app.component("VitepressDemoPlaceholder", VitepressDemoPlaceholder);
 
 			params?.enhanceAppCallBack?.({ app, router, siteData });
 		},
 	} satisfies Theme;
 }
+
+/** 默认布局配置 */
+export const defaultLayoutConfig = {
+	// 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 预设 */
+export function defaultEnhanceAppPreset({ 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);
+}
+
+/** 默认主题配置 */
+export const defaultTheme = {
+	extends: DefaultTheme,
+	Layout: () => {
+		return h(DefaultTheme.Layout, null, defaultLayoutConfig);
+	},
+	enhanceApp({ app, router, siteData }: EnhanceAppContext) {
+		defaultEnhanceAppPreset({ app, router, siteData });
+		/**
+		 * 放弃全局注册demo展示组件
+		 * 在生产环境内使用peer对等依赖
+		 */
+		// app.component("VitepressDemoBox", VitepressDemoBox);
+		// app.component("VitepressDemoPlaceholder", VitepressDemoPlaceholder);
+	},
+} satisfies Theme;