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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/theme.d.mts +22 -3
  2. package/dist/theme.mjs +30 -0
  3. package/package.json +5 -3
  4. package/src/theme.ts +46 -2
package/dist/theme.d.mts CHANGED
@@ -28,7 +28,11 @@ declare function defineRuancatPresetTheme(params?: DefineRuancatPresetThemeParam
28
28
  }>;
29
29
  enhanceApp({ app, router, siteData }: EnhanceAppContext): void;
30
30
  };
31
- /** 默认布局配置 */
31
+ /**
32
+ * 默认布局配置
33
+ * @description
34
+ * 有疑惑 经过测试 该写法会导致找不到主题文件
35
+ */
32
36
  declare const defaultLayoutConfig: {
33
37
  "doc-before": () => vue.VNode<vue.RendererNode, vue.RendererElement, {
34
38
  [key: string]: any;
@@ -43,7 +47,11 @@ declare const defaultLayoutConfig: {
43
47
  [key: string]: any;
44
48
  }>[];
45
49
  };
46
- /** 默认 enhanceApp 预设 */
50
+ /**
51
+ * 默认 enhanceApp 预设
52
+ * @description
53
+ * 有疑惑 经过测试 该写法会导致找不到主题文件
54
+ */
47
55
  declare function defaultEnhanceAppPreset({ app, router, siteData }: EnhanceAppContext): void;
48
56
  /** 默认主题配置 */
49
57
  declare const defaultTheme: {
@@ -56,5 +64,16 @@ declare const defaultTheme: {
56
64
  }>;
57
65
  enhanceApp({ app, router, siteData }: EnhanceAppContext): void;
58
66
  };
67
+ /**
68
+ * 默认主题配置2
69
+ * @description
70
+ * 从 @sugarat/theme 内学习的配置写法
71
+ */
72
+ declare const defaultTheme2: {
73
+ Layout: () => vue.VNode<vue.RendererNode, vue.RendererElement, {
74
+ [key: string]: any;
75
+ }>;
76
+ enhanceApp(ctx: EnhanceAppContext): void;
77
+ };
59
78
 
60
- export { type DefineRuancatPresetThemeParams, type EnhanceAppCallBack, defaultEnhanceAppPreset, defaultLayoutConfig, defaultTheme, defineRuancatPresetTheme };
79
+ export { type DefineRuancatPresetThemeParams, type EnhanceAppCallBack, defaultEnhanceAppPreset, defaultLayoutConfig, defaultTheme, defaultTheme2, defineRuancatPresetTheme };
package/dist/theme.mjs CHANGED
@@ -75,9 +75,39 @@ var defaultTheme = {
75
75
  defaultEnhanceAppPreset({ app, router, siteData });
76
76
  }
77
77
  };
78
+ var defaultTheme2 = {
79
+ ...DefaultTheme,
80
+ Layout: () => {
81
+ return h(DefaultTheme.Layout, null, {
82
+ // https://vitepress.dev/guide/extending-default-theme#layout-slots
83
+ "doc-before": () => h(NolebaseBreadcrumbs),
84
+ "nav-bar-content-after": () => h(NolebaseEnhancedReadabilitiesMenu),
85
+ // 为较窄的屏幕（通常是小于 iPad Mini）添加阅读增强菜单
86
+ "nav-screen-content-after": () => h(NolebaseEnhancedReadabilitiesScreenMenu),
87
+ "layout-top": () => [h(NolebaseHighlightTargetedHeading)]
88
+ });
89
+ },
90
+ enhanceApp(ctx) {
91
+ DefaultTheme.enhanceApp(ctx);
92
+ ctx.app.use(NolebaseGitChangelogPlugin);
93
+ ctx.app.use(TwoslashFloatingVue);
94
+ ctx.app.provide(InjectionKey, {
95
+ layoutSwitch: {
96
+ defaultMode: LayoutMode["BothWidthAdjustable"],
97
+ pageLayoutMaxWidth: {
98
+ defaultMaxWidth: 85
99
+ },
100
+ contentLayoutMaxWidth: {
101
+ defaultMaxWidth: 95
102
+ }
103
+ }
104
+ });
105
+ }
106
+ };
78
107
  export {
79
108
  defaultEnhanceAppPreset,
80
109
  defaultLayoutConfig,
81
110
  defaultTheme,
111
+ defaultTheme2,
82
112
  defineRuancatPresetTheme
83
113
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ruan-cat/vitepress-preset-config",
3
- "version": "0.7.0",
3
+ "version": "0.7.2",
4
4
  "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
5
5
  "homepage": "https://vitepress-preset.ruancat6312.top",
6
6
  "types": "./src/config.mts",
@@ -57,7 +57,8 @@
57
57
  "import": "./dist/theme.mjs",
58
58
  "types": "./src/theme.ts"
59
59
  },
60
- "./theme.css": "./dist/theme.css"
60
+ "./theme.css": "./dist/theme.css",
61
+ "./src/*": "./src/*"
61
62
  },
62
63
  "keywords": [
63
64
  "vitepress"
@@ -87,7 +88,8 @@
87
88
  "!src/tests",
88
89
  "!src/**/tests",
89
90
  "!src/**/*.md",
90
- "!src/.vitepress/cache"
91
+ "!src/.vitepress/cache",
92
+ "!src/.vitepress/dist"
91
93
  ],
92
94
  "scripts": {
93
95
  "docs:dev": "vitepress dev src --port 8080",
package/src/theme.ts CHANGED
@@ -91,7 +91,11 @@ export function defineRuancatPresetTheme(params?: DefineRuancatPresetThemeParams
91
91
  } satisfies Theme;
92
92
  }
93
93
 
94
- /** 默认布局配置 */
94
+ /**
95
+ * 默认布局配置
96
+ * @description
97
+ * 有疑惑 经过测试 该写法会导致找不到主题文件
98
+ */
95
99
  export const defaultLayoutConfig = {
96
100
  // https://vitepress.dev/guide/extending-default-theme#layout-slots
97
101
  "doc-before": () => h(NolebaseBreadcrumbs),
@@ -101,7 +105,11 @@ export const defaultLayoutConfig = {
101
105
  "layout-top": () => [h(NolebaseHighlightTargetedHeading)],
102
106
  };
103
107
 
104
- /** 默认 enhanceApp 预设 */
108
+ /**
109
+ * 默认 enhanceApp 预设
110
+ * @description
111
+ * 有疑惑 经过测试 该写法会导致找不到主题文件
112
+ */
105
113
  export function defaultEnhanceAppPreset({ app, router, siteData }: EnhanceAppContext) {
106
114
  app.use(NolebaseGitChangelogPlugin);
107
115
  app.use(TwoslashFloatingVue);
@@ -134,3 +142,39 @@ export const defaultTheme = {
134
142
  // app.component("VitepressDemoPlaceholder", VitepressDemoPlaceholder);
135
143
  },
136
144
  } satisfies Theme;
145
+
146
+ /**
147
+ * 默认主题配置2
148
+ * @description
149
+ * 从 @sugarat/theme 内学习的配置写法
150
+ */
151
+ export const defaultTheme2 = {
152
+ ...DefaultTheme,
153
+ Layout: () => {
154
+ return h(DefaultTheme.Layout, null, {
155
+ // https://vitepress.dev/guide/extending-default-theme#layout-slots
156
+ "doc-before": () => h(NolebaseBreadcrumbs),
157
+ "nav-bar-content-after": () => h(NolebaseEnhancedReadabilitiesMenu),
158
+ // 为较窄的屏幕（通常是小于 iPad Mini）添加阅读增强菜单
159
+ "nav-screen-content-after": () => h(NolebaseEnhancedReadabilitiesScreenMenu),
160
+ "layout-top": () => [h(NolebaseHighlightTargetedHeading)],
161
+ });
162
+ },
163
+ enhanceApp(ctx: EnhanceAppContext) {
164
+ DefaultTheme.enhanceApp(ctx);
165
+
166
+ ctx.app.use(NolebaseGitChangelogPlugin);
167
+ ctx.app.use(TwoslashFloatingVue);
168
+ ctx.app.provide(InjectionKey, {
169
+ layoutSwitch: {
170
+ defaultMode: LayoutMode["BothWidthAdjustable"],
171
+ pageLayoutMaxWidth: {
172
+ defaultMaxWidth: 85,
173
+ },
174
+ contentLayoutMaxWidth: {
175
+ defaultMaxWidth: 95,
176
+ },
177
+ },
178
+ } as Options);
179
+ },
180
+ } satisfies Theme;