@ruan-cat/vitepress-preset-config 1.4.0 → 2.0.0

package/dist/config.d.mts

@@ -2,8 +2,49 @@ import * as vitepress_sidebar_types from 'vitepress-sidebar/types';
 import { UserConfig, DefaultTheme } from 'vitepress';
 export { defineConfig } from 'vitepress';
 import { generateSidebar } from 'vitepress-sidebar';
+import llmstxt from 'vitepress-plugin-llms';
+import { GitChangelog, GitChangelogMarkdownSectionOptions } from '@nolebase/vitepress-plugin-git-changelog/vite';
+import { defineTeekConfig } from 'vitepress-theme-teek/config';
 export { addChangelog2doc, copyReadmeMd } from '@ruan-cat/utils/node-esm';
 
+type LlmstxtSettings = NonNullable<Parameters<typeof llmstxt>[0]>;
+type GitChangelogOptions = NonNullable<Parameters<typeof GitChangelog>[0]>;
+type TeekConfigOptions = NonNullable<Parameters<typeof defineTeekConfig>[0]>;
+/**
+ * 额外的配置
+ * @description
+ * 目前主要用于精细化配置 vitepress 的插件
+ */
+interface ExtraConfig {
+    /**
+     * 即 vite 的 plugins
+     * @description
+     * vitepress 配置的一系列插件
+     */
+    plugins?: {
+        /**
+         * @description 用于配置 vitepress-plugin-llms 插件
+         * @see https://github.com/okineadev/vitepress-plugin-llms
+         */
+        llmstxt?: LlmstxtSettings | false;
+        /**
+         * @description 用于配置 @nolebase/vitepress-plugin-git-changelog 插件
+         * @see
+         */
+        gitChangelog?: GitChangelogOptions | false;
+        /**
+         * @description 用于配置 @nolebase/vitepress-plugin-git-changelog-markdown-section 插件
+         * @see
+         */
+        gitChangelogMarkdownSection?: GitChangelogMarkdownSectionOptions | false;
+    };
+    /**
+     * Teek 主题配置
+     * @see https://vp.teek.top/reference/config.html
+     */
+    teekConfig?: TeekConfigOptions;
+}
+
 type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
 /**
  * 设置自动生成侧边栏的配置
@@ -11,6 +52,6 @@ type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
  */
 declare function setGenerateSidebar(options?: VitePressSidebarOptions): vitepress_sidebar_types.Sidebar;
 /** 设置vitepress主配置 */
-declare function setUserConfig(config?: UserConfig<DefaultTheme.Config>): UserConfig<DefaultTheme.Config>;
+declare function setUserConfig(config?: UserConfig<DefaultTheme.Config>, extraConfig?: ExtraConfig): UserConfig<DefaultTheme.Config>;
 
 export { setGenerateSidebar, setUserConfig };

package/dist/config.mjs

@@ -1,16 +1,50 @@
 // 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 { merge as merge2, isUndefined, cloneDeep as cloneDeep2 } from "lodash-es";
 import consola from "consola";
 import { addChangelog2doc, hasChangelogMd, copyReadmeMd } from "@ruan-cat/utils/node-esm";
 import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
-import llmstxt from "vitepress-plugin-llms";
-import { MermaidPlugin } from "@leelaa/vitepress-plugin-extended";
+
+// src/config/plugins.ts
+import vitepressPluginLlmstxt from "vitepress-plugin-llms";
+import { GitChangelog, GitChangelogMarkdownSection } from "@nolebase/vitepress-plugin-git-changelog/vite";
+function isFalse(value) {
+  return value === false;
+}
+var defaultGitChangelogOptions = {
+  // 填写在此处填写您的仓库链接
+  repoURL: () => "https://github.com/ruan-cat/monorepo",
+  // 最大日志深度为10, 避免获取过多无意义的历史日志
+  maxGitLogCount: 10
+};
+function getPlugins(extraConfig) {
+  const plugins = [];
+  const {
+    llmstxt,
+    gitChangelog = defaultGitChangelogOptions,
+    gitChangelogMarkdownSection
+  } = (extraConfig == null ? void 0 : extraConfig.plugins) || {};
+  if (!isFalse(llmstxt)) {
+    plugins.push(vitepressPluginLlmstxt(llmstxt));
+  }
+  if (!isFalse(gitChangelog)) {
+    plugins.push(GitChangelog(gitChangelog));
+  }
+  if (!isFalse(gitChangelogMarkdownSection)) {
+    plugins.push(GitChangelogMarkdownSection(gitChangelogMarkdownSection));
+  }
+  return plugins;
+}
+function handlePlugins(userConfig, extraConfig) {
+  userConfig.vite.plugins = getPlugins(extraConfig);
+}
+
+// src/config/teek.ts
 import { defineTeekConfig } from "vitepress-theme-teek/config";
-var teekConfig = defineTeekConfig({
+import { merge, cloneDeep } from "lodash-es";
+var defaultTeekConfig = {
   /** @see https://vp.teek.top/reference/config/global-config.html#sidebartrigger */
   sidebarTrigger: true,
   /**
@@ -48,7 +82,15 @@ var teekConfig = defineTeekConfig({
     hash: false
     // 是否包含哈希值
   }
-});
+};
+function handleTeekConfig(userConfig, extraConfig) {
+  const { teekConfig = defaultTeekConfig } = extraConfig ?? {};
+  userConfig.extends = defineTeekConfig(merge({}, cloneDeep(defaultTeekConfig), teekConfig));
+}
+
+// src/config.mts
+import { MermaidPlugin } from "@leelaa/vitepress-plugin-extended";
+import { defineTeekConfig as defineTeekConfig2 } from "vitepress-theme-teek/config";
 var defaultSidebarOptions = {
   // documentRootPath: "src",
   // 侧边栏需要折叠
@@ -75,13 +117,17 @@ var defaultSidebarOptions = {
   debugPrint: false
 };
 function getMergeSidebarOptions(options) {
-  return merge({}, cloneDeep(defaultSidebarOptions), isUndefined(options) ? {} : options);
+  return merge2({}, cloneDeep2(defaultSidebarOptions), isUndefined(options) ? {} : options);
 }
 function setGenerateSidebar(options) {
   return generateSidebar(getMergeSidebarOptions(options));
 }
 var defaultUserConfig = {
-  extends: teekConfig,
+  /**
+   * 使用默认的 Teek 主题配置
+   * 后续会有函数重新设置 Teek 主题配置，并覆盖默认配置
+   */
+  extends: defineTeekConfig2(defaultTeekConfig),
   title: "\u8BF7\u586B\u5199\u6709\u610F\u4E49\u7684\u6807\u9898",
   description: "\u8BF7\u586B\u5199\u6709\u610F\u4E49\u7684\u63CF\u8FF0",
   lang: "zh",
@@ -89,9 +135,7 @@ var defaultUserConfig = {
   // srcDir: "./src",
   themeConfig: {
     i18nRouting: true,
-    search: {
-      provider: "local"
-    },
+    search: { provider: "local" },
     // https://vitepress.dev/reference/default-theme-config
     nav: [{ text: "\u9996\u9875", link: "/" }],
     outline: {
@@ -100,35 +144,17 @@ var defaultUserConfig = {
     },
     // 自动化侧边栏
     sidebar: setGenerateSidebar(),
-    socialLinks: [
-      {
-        icon: "github",
-        link: "https://github.com/ruan-cat"
-      }
-    ]
+    socialLinks: [{ icon: "github", link: "https://github.com/ruan-cat" }]
   },
   vite: {
-    server: {
-      open: true,
-      port: 8080
-    },
-    plugins: [
-      /** @see https://github.com/okineadev/vitepress-plugin-llms */
-      // @ts-ignore
-      llmstxt(),
-      // @ts-ignore
-      GitChangelog({
-        // 填写在此处填写您的仓库链接
-        repoURL: () => "https://github.com/ruan-cat/monorepo",
-        // 最大日志深度为10, 避免获取过多无意义的历史日志
-        maxGitLogCount: 10
-      }),
-      // @ts-ignore
-      GitChangelogMarkdownSection()
-    ],
-    optimizeDeps: {
-      exclude: ["vitepress", "@nolebase/ui"]
-    },
+    server: { open: true, port: 8080 },
+    /**
+     * 插件
+     * @description
+     * 这里留空 插件在 config/plugins.ts 中配置
+     */
+    plugins: [],
+    optimizeDeps: { exclude: ["vitepress", "@nolebase/ui"] },
     ssr: {
       noExternal: [
         // 如果还有别的依赖需要添加的话，并排填写和配置到这里即可
@@ -176,9 +202,11 @@ function handleChangeLog(userConfig) {
   }
   nav.push({ text: "\u66F4\u65B0\u65E5\u5FD7", link: "/CHANGELOG.md" });
 }
-function setUserConfig(config) {
-  const resUserConfig = merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
+function setUserConfig(config, extraConfig) {
+  const resUserConfig = merge2({}, cloneDeep2(defaultUserConfig), isUndefined(config) ? {} : config);
   handleChangeLog(resUserConfig);
+  handlePlugins(resUserConfig, extraConfig);
+  handleTeekConfig(resUserConfig, extraConfig);
   return resUserConfig;
 }
 export {

package/dist/theme.d.mts

@@ -22,7 +22,6 @@ declare const defaultTheme: {
         extends: vitepress_theme_teek.DefaultThemeType;
         enhanceApp: (options: EnhanceAppContext) => Promise<void>;
     };
-    Layout: vue.DefineComponent;
     enhanceApp({ app, router, siteData }: EnhanceAppContext): void;
 };
 /**
@@ -37,7 +36,6 @@ declare function defineRuancatPresetTheme(params?: DefineRuancatPresetThemeParam
         extends: vitepress_theme_teek.DefaultThemeType;
         enhanceApp: (options: EnhanceAppContext) => Promise<void>;
     };
-    Layout: vue.DefineComponent;
 };
 
 export { type DefineRuancatPresetThemeParams, type EnhanceAppCallBack, defaultTheme, defineRuancatPresetTheme };

package/dist/theme.mjs

@@ -13,7 +13,8 @@ function defaultEnhanceAppPreset({ app, router, siteData }) {
 }
 var defaultTheme = {
   extends: Teek,
-  Layout: Teek.Layout,
+  // 有疑惑 根据和 teek 作者的沟通 这个配置可以不写
+  // Layout: Teek.Layout,
   enhanceApp({ app, router, siteData }) {
     defaultEnhanceAppPreset({ app, router, siteData });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
   "homepage": "https://vitepress-preset.ruancat6312.top",
   "types": "./src/config.mts",

package/src/config/index.ts

@@ -0,0 +1,4 @@
+// 专门为 packages\vitepress-preset-config\src\config.mts 服务的文件 提供额外配置
+
+export * from "./plugins";
+export * from "./teek";

package/src/config/plugins.ts

@@ -0,0 +1,53 @@
+import { type DefaultTheme, type UserConfig } from "vitepress";
+import vitepressPluginLlmstxt from "vitepress-plugin-llms";
+import { GitChangelog, GitChangelogMarkdownSection } from "@nolebase/vitepress-plugin-git-changelog/vite";
+
+import type { ExtraConfig, GitChangelogOptions } from "../types.ts";
+
+function isFalse(value: unknown): value is false {
+	return value === false;
+}
+
+const defaultGitChangelogOptions: GitChangelogOptions = {
+	// 填写在此处填写您的仓库链接
+	repoURL: () => "https://github.com/ruan-cat/monorepo",
+	// 最大日志深度为10, 避免获取过多无意义的历史日志
+	maxGitLogCount: 10,
+};
+
+/**
+ * 根据配置 返回插件列表
+ * @description
+ * 该函数将根据具体的配置 返回插件列表
+ */
+export function getPlugins(extraConfig?: ExtraConfig) {
+	const plugins = [];
+	const {
+		llmstxt,
+		gitChangelog = defaultGitChangelogOptions,
+		gitChangelogMarkdownSection,
+	} = extraConfig?.plugins || {};
+
+	if (!isFalse(llmstxt)) {
+		plugins.push(vitepressPluginLlmstxt(llmstxt));
+	}
+
+	if (!isFalse(gitChangelog)) {
+		plugins.push(GitChangelog(gitChangelog));
+	}
+
+	if (!isFalse(gitChangelogMarkdownSection)) {
+		plugins.push(GitChangelogMarkdownSection(gitChangelogMarkdownSection));
+	}
+
+	return plugins;
+}
+
+/**
+ * 根据用户的额外配置 设置`文档配置`的 vite 插件
+ * @description
+ */
+export function handlePlugins(userConfig: UserConfig<DefaultTheme.Config>, extraConfig?: ExtraConfig) {
+	// @ts-ignore
+	userConfig.vite.plugins = getPlugins(extraConfig);
+}

package/src/config/teek.ts

@@ -0,0 +1,59 @@
+import { type DefaultTheme, type UserConfig } from "vitepress";
+import { defineTeekConfig } from "vitepress-theme-teek/config";
+import { merge, cloneDeep } from "lodash-es";
+
+import type { TeekConfigOptions, ExtraConfig } from "../types";
+
+/**
+ * 默认的 Teek 主题配置
+ * @see https://vp.teek.top/reference/config.html
+ */
+export const defaultTeekConfig: TeekConfigOptions = {
+	/** @see https://vp.teek.top/reference/config/global-config.html#sidebartrigger */
+	sidebarTrigger: true,
+
+	/**
+	 * 关闭 Teek 主题的首页风格
+	 * @see https://vp.teek.top/reference/config/global-config.html#teekhome
+	 */
+	teekHome: false,
+
+	vitePlugins: {
+		/**
+		 * 关闭 vitepress-plugin-permalink 插件
+		 * @see https://vp.teek.top/guide/plugins.html#vitepress-plugin-permalink
+		 */
+		permalink: false,
+
+		/**
+		 * 关闭 vitepress-plugin-sidebar-resolve 插件
+		 * @see https://vp.teek.top/guide/plugins.html#vitepress-plugin-sidebar-resolve
+		 */
+		sidebar: false,
+
+		/**
+		 * 关闭 vitepress-plugin-md-h1 插件
+		 * @see https://vp.teek.top/guide/plugins.html#vitepress-plugin-md-h1
+		 */
+		mdH1: false,
+	},
+
+	/** @see https://vp.teek.top/reference/article-config.html#articleshare */
+	articleShare: {
+		enabled: true, // 是否开启文章链接分享功能
+		text: "分享此页面", // 分享按钮文本
+		copiedText: "链接已复制", // 复制成功文本
+		query: false, // 是否包含查询参数
+		hash: false, // 是否包含哈希值
+	},
+};
+
+/**
+ * 根据用户的额外配置 设置`文档配置`的 teek 主题配置
+ * @description
+ */
+export function handleTeekConfig(userConfig: UserConfig<DefaultTheme.Config>, extraConfig?: ExtraConfig) {
+	const { teekConfig = defaultTeekConfig } = extraConfig ?? {};
+	// @ts-ignore
+	userConfig.extends = defineTeekConfig(merge({}, cloneDeep(defaultTeekConfig), teekConfig));
+}

package/src/config.mts

@@ -7,6 +7,7 @@ import { vitepressDemoPlugin } from "vitepress-demo-plugin";
 
 import { merge, isUndefined, cloneDeep } from "lodash-es";
 import consola from "consola";
+import type { ExtraConfig } from "./types.ts";
 
 import { addChangelog2doc, hasChangelogMd, copyReadmeMd } from "@ruan-cat/utils/node-esm";
 export { addChangelog2doc, copyReadmeMd };
@@ -15,53 +16,14 @@ import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 
 import llmstxt from "vitepress-plugin-llms";
 
+import { defaultTeekConfig, handleTeekConfig, handlePlugins } from "./config/index.ts";
+
 /** @see https://vitepress-ext.leelaa.cn/Mermaid.html#扩展-md-插件 */
 import { MermaidPlugin } from "@leelaa/vitepress-plugin-extended";
 
 // https://vp.teek.top/guide/quickstart.html#teek-引入
 import { defineTeekConfig } from "vitepress-theme-teek/config";
 
-/** Teek 主题配置 */
-const teekConfig = defineTeekConfig({
-	/** @see https://vp.teek.top/reference/config/global-config.html#sidebartrigger */
-	sidebarTrigger: true,
-
-	/**
-	 * 关闭 Teek 主题的首页风格
-	 * @see https://vp.teek.top/reference/config/global-config.html#teekhome
-	 */
-	teekHome: false,
-
-	vitePlugins: {
-		/**
-		 * 关闭 vitepress-plugin-permalink 插件
-		 * @see https://vp.teek.top/guide/plugins.html#vitepress-plugin-permalink
-		 */
-		permalink: false,
-
-		/**
-		 * 关闭 vitepress-plugin-sidebar-resolve 插件
-		 * @see https://vp.teek.top/guide/plugins.html#vitepress-plugin-sidebar-resolve
-		 */
-		sidebar: false,
-
-		/**
-		 * 关闭 vitepress-plugin-md-h1 插件
-		 * @see https://vp.teek.top/guide/plugins.html#vitepress-plugin-md-h1
-		 */
-		mdH1: false,
-	},
-
-	/** @see https://vp.teek.top/reference/article-config.html#articleshare */
-	articleShare: {
-		enabled: true, // 是否开启文章链接分享功能
-		text: "分享此页面", // 分享按钮文本
-		copiedText: "链接已复制", // 复制成功文本
-		query: false, // 是否包含查询参数
-		hash: false, // 是否包含哈希值
-	},
-});
-
 type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
 
 /** 默认侧边栏配置 */
@@ -117,7 +79,11 @@ export function setGenerateSidebar(options?: VitePressSidebarOptions) {
 
 /** 默认用户配置 */
 const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
-	extends: teekConfig,
+	/**
+	 * 使用默认的 Teek 主题配置
+	 * 后续会有函数重新设置 Teek 主题配置，并覆盖默认配置
+	 */
+	extends: defineTeekConfig(defaultTeekConfig),
 
 	title: "请填写有意义的标题",
 	description: "请填写有意义的描述",
@@ -129,9 +95,7 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 	themeConfig: {
 		i18nRouting: true,
 
-		search: {
-			provider: "local",
-		},
+		search: { provider: "local" },
 
 		// https://vitepress.dev/reference/default-theme-config
 		nav: [{ text: "首页", link: "/" }],
@@ -144,40 +108,20 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 		// 自动化侧边栏
 		sidebar: setGenerateSidebar(),
 
-		socialLinks: [
-			{
-				icon: "github",
-				link: "https://github.com/ruan-cat",
-			},
-		],
+		socialLinks: [{ icon: "github", link: "https://github.com/ruan-cat" }],
 	},
 
 	vite: {
-		server: {
-			open: true,
-			port: 8080,
-		},
-
-		plugins: [
-			/** @see https://github.com/okineadev/vitepress-plugin-llms */
-			// @ts-ignore
-			llmstxt(),
-
-			// @ts-ignore
-			GitChangelog({
-				// 填写在此处填写您的仓库链接
-				repoURL: () => "https://github.com/ruan-cat/monorepo",
-				// 最大日志深度为10, 避免获取过多无意义的历史日志
-				maxGitLogCount: 10,
-			}),
+		server: { open: true, port: 8080 },
 
-			// @ts-ignore
-			GitChangelogMarkdownSection(),
-		],
+		/**
+		 * 插件
+		 * @description
+		 * 这里留空 插件在 config/plugins.ts 中配置
+		 */
+		plugins: [],
 
-		optimizeDeps: {
-			exclude: ["vitepress", "@nolebase/ui"],
-		},
+		optimizeDeps: { exclude: ["vitepress", "@nolebase/ui"] },
 
 		ssr: {
 			noExternal: [
@@ -246,12 +190,21 @@ function handleChangeLog(userConfig: UserConfig<DefaultTheme.Config>) {
 }
 
 /** 设置vitepress主配置 */
-export function setUserConfig(config?: UserConfig<DefaultTheme.Config>): UserConfig<DefaultTheme.Config> {
+export function setUserConfig(
+	config?: UserConfig<DefaultTheme.Config>,
+	extraConfig?: ExtraConfig,
+): UserConfig<DefaultTheme.Config> {
 	/** 最终的用户数据 */
 	const resUserConfig = merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
 
 	// 增加导航栏
 	handleChangeLog(resUserConfig);
 
+	// 设置插件
+	handlePlugins(resUserConfig, extraConfig);
+
+	// 设置 Teek 主题配置
+	handleTeekConfig(resUserConfig, extraConfig);
+
 	return resUserConfig;
 }

package/src/index.ts

@@ -0,0 +1,6 @@
+// 警告 设计失误 将 `文档配置` 和 `主题配置` 共同导出时 会出现css无法识别的错误。
+
+export * from "./config/index.ts";
+export * from "./theme.ts";
+export * from "./config.mts";
+export * from "./types.ts";

package/src/theme.ts

@@ -55,7 +55,8 @@ function defaultEnhanceAppPreset({ app, router, siteData }: EnhanceAppContext) {
 /** 默认主题配置 */
 export const defaultTheme = {
 	extends: Teek,
-	Layout: Teek.Layout,
+	// 有疑惑 根据和 teek 作者的沟通 这个配置可以不写
+	// Layout: Teek.Layout,
 	enhanceApp({ app, router, siteData }: EnhanceAppContext) {
 		defaultEnhanceAppPreset({ app, router, siteData });
 	},

package/src/types.ts

@@ -0,0 +1,49 @@
+import llmstxt from "vitepress-plugin-llms";
+import { GitChangelog, type GitChangelogMarkdownSectionOptions } from "@nolebase/vitepress-plugin-git-changelog/vite";
+
+// https://vp.teek.top/guide/quickstart.html#teek-引入
+import { defineTeekConfig } from "vitepress-theme-teek/config";
+
+export type LlmstxtSettings = NonNullable<Parameters<typeof llmstxt>[0]>;
+
+export type GitChangelogOptions = NonNullable<Parameters<typeof GitChangelog>[0]>;
+
+export type TeekConfigOptions = NonNullable<Parameters<typeof defineTeekConfig>[0]>;
+
+/**
+ * 额外的配置
+ * @description
+ * 目前主要用于精细化配置 vitepress 的插件
+ */
+export interface ExtraConfig {
+	/**
+	 * 即 vite 的 plugins
+	 * @description
+	 * vitepress 配置的一系列插件
+	 */
+	plugins?: {
+		/**
+		 * @description 用于配置 vitepress-plugin-llms 插件
+		 * @see https://github.com/okineadev/vitepress-plugin-llms
+		 */
+		llmstxt?: LlmstxtSettings | false;
+
+		/**
+		 * @description 用于配置 @nolebase/vitepress-plugin-git-changelog 插件
+		 * @see
+		 */
+		gitChangelog?: GitChangelogOptions | false;
+
+		/**
+		 * @description 用于配置 @nolebase/vitepress-plugin-git-changelog-markdown-section 插件
+		 * @see
+		 */
+		gitChangelogMarkdownSection?: GitChangelogMarkdownSectionOptions | false;
+	};
+
+	/**
+	 * Teek 主题配置
+	 * @see https://vp.teek.top/reference/config.html
+	 */
+	teekConfig?: TeekConfigOptions;
+}