@ruan-cat/vitepress-preset-config 0.14.0 → 0.16.0

package/dist/config.d.mts

@@ -2,10 +2,20 @@ 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';
+export { addChangelog2doc, copyReadmeMd } from '@ruan-cat/utils/node-esm';
 export { withMermaid } from 'vitepress-plugin-mermaid';
 export { default as VitePluginVercel } from 'vite-plugin-vercel';
 
+/** 阮喵喵针对文档行为的配置 */
+interface RuanCatConfig {
+    plugins?: {
+        llmstxt?: boolean;
+        gitChangelog?: boolean;
+        gitChangelogMarkdownSection?: boolean;
+        vitePluginVercel?: boolean;
+    };
+}
+
 type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
 /**
  * 设置自动生成侧边栏的配置
@@ -13,6 +23,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>, ruanCatConfig?: RuanCatConfig): UserConfig<DefaultTheme.Config>;
 
-export { setGenerateSidebar, setUserConfig };
+export { type RuanCatConfig, setGenerateSidebar, setUserConfig };

package/dist/config.mjs

@@ -5,7 +5,7 @@ import { GitChangelog, GitChangelogMarkdownSection } from "@nolebase/vitepress-p
 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";
+import { addChangelog2doc, hasChangelogMd, copyReadmeMd } from "@ruan-cat/utils/node-esm";
 import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 import llmstxt from "vitepress-plugin-llms";
 import { withMermaid } from "vitepress-plugin-mermaid";
@@ -41,6 +41,22 @@ function getMergeSidebarOptions(options) {
 function setGenerateSidebar(options) {
   return generateSidebar(getMergeSidebarOptions(options));
 }
+var defaultLlmstxt = llmstxt();
+var defaultGitChangelog = GitChangelog({
+  // 填写在此处填写您的仓库链接
+  repoURL: () => "https://github.com/ruan-cat/monorepo",
+  // 最大日志深度为10, 避免获取过多无意义的历史日志
+  maxGitLogCount: 10
+});
+var defaultGitChangelogMarkdownSection = GitChangelogMarkdownSection();
+var defaultVitePluginVercel = VitePluginVercel();
+var defaultVitePlugins = [
+  defaultLlmstxt,
+  defaultGitChangelog,
+  defaultGitChangelogMarkdownSection,
+  // @ts-ignore
+  defaultVitePluginVercel
+];
 var defaultUserConfig = {
   title: "\u8BF7\u586B\u5199\u6709\u610F\u4E49\u7684\u6807\u9898",
   description: "\u8BF7\u586B\u5199\u6709\u610F\u4E49\u7684\u63CF\u8FF0",
@@ -71,21 +87,8 @@ var defaultUserConfig = {
     server: {
       open: true
     },
-    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(),
-      VitePluginVercel()
-    ],
+    // @ts-ignore
+    plugins: defaultVitePlugins,
     optimizeDeps: {
       exclude: [
         "@nolebase/vitepress-plugin-breadcrumbs/client",
@@ -135,14 +138,42 @@ function handleChangeLog(userConfig) {
   }
   nav.push({ text: "\u66F4\u65B0\u65E5\u5FD7", link: "/CHANGELOG.md" });
 }
-function setUserConfig(config) {
+var defaultRuanCatConfig = {
+  plugins: {
+    llmstxt: true,
+    gitChangelog: true,
+    gitChangelogMarkdownSection: true,
+    vitePluginVercel: true
+  }
+};
+function handlePlugins(userConfig, ruanCatConfig = defaultRuanCatConfig) {
+  var _a, _b, _c, _d;
+  let resPlugins = [];
+  ruanCatConfig = merge({}, cloneDeep(defaultRuanCatConfig), ruanCatConfig);
+  if ((_a = ruanCatConfig == null ? void 0 : ruanCatConfig.plugins) == null ? void 0 : _a.llmstxt) {
+    resPlugins.push(defaultLlmstxt);
+  }
+  if ((_b = ruanCatConfig == null ? void 0 : ruanCatConfig.plugins) == null ? void 0 : _b.gitChangelog) {
+    resPlugins.push(defaultGitChangelog);
+  }
+  if ((_c = ruanCatConfig == null ? void 0 : ruanCatConfig.plugins) == null ? void 0 : _c.gitChangelogMarkdownSection) {
+    resPlugins.push(defaultGitChangelogMarkdownSection);
+  }
+  if ((_d = ruanCatConfig == null ? void 0 : ruanCatConfig.plugins) == null ? void 0 : _d.vitePluginVercel) {
+    resPlugins.push(defaultVitePluginVercel);
+  }
+  userConfig.vite.plugins = resPlugins;
+}
+function setUserConfig(config, ruanCatConfig = defaultRuanCatConfig) {
   const resUserConfig = merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
   handleChangeLog(resUserConfig);
+  handlePlugins(resUserConfig, ruanCatConfig);
   return resUserConfig;
 }
 export {
   VitePluginVercel,
   addChangelog2doc,
+  copyReadmeMd,
   defineConfig,
   setGenerateSidebar,
   setUserConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
   "homepage": "https://vitepress-preset.ruancat6312.top",
   "types": "./src/config.mts",
@@ -23,7 +23,7 @@
     "vitepress-plugin-mermaid": "^2.0.17",
     "vitepress-sidebar": "^1.31.1",
     "vue": "^3.5.13",
-    "@ruan-cat/utils": "^4.8.1"
+    "@ruan-cat/utils": "^4.9.0"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",

package/src/config.mts

@@ -1,7 +1,10 @@
+import { type PluginOption } from "vite";
 import { defineConfig, type DefaultTheme, type UserConfig } from "vitepress";
+export { defineConfig };
 import { generateSidebar, withSidebar } from "vitepress-sidebar";
 
-export { defineConfig };
+import { type RuanCatConfig } from "./type.ts";
+export { RuanCatConfig };
 
 import { GitChangelog, GitChangelogMarkdownSection } from "@nolebase/vitepress-plugin-git-changelog/vite";
 import { vitepressDemoPlugin } from "vitepress-demo-plugin";
@@ -9,8 +12,8 @@ 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";
-export { addChangelog2doc };
+import { addChangelog2doc, hasChangelogMd, copyReadmeMd } from "@ruan-cat/utils/node-esm";
+export { addChangelog2doc, copyReadmeMd };
 
 import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 
@@ -84,6 +87,29 @@ export function setGenerateSidebar(options?: VitePressSidebarOptions) {
 	return generateSidebar(getMergeSidebarOptions(options));
 }
 
+/** @see https://github.com/okineadev/vitepress-plugin-llms */
+const defaultLlmstxt = llmstxt();
+
+const defaultGitChangelog = GitChangelog({
+	// 填写在此处填写您的仓库链接
+	repoURL: () => "https://github.com/ruan-cat/monorepo",
+	// 最大日志深度为10, 避免获取过多无意义的历史日志
+	maxGitLogCount: 10,
+});
+
+const defaultGitChangelogMarkdownSection = GitChangelogMarkdownSection();
+
+const defaultVitePluginVercel = VitePluginVercel();
+
+/** 默认的vite插件 */
+const defaultVitePlugins: PluginOption[] = [
+	defaultLlmstxt,
+	defaultGitChangelog,
+	defaultGitChangelogMarkdownSection,
+	// @ts-ignore
+	defaultVitePluginVercel,
+];
+
 /** 默认用户配置 */
 const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 	title: "请填写有意义的标题",
@@ -124,24 +150,8 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 			open: true,
 		},
 
-		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(),
-
-			VitePluginVercel(),
-		],
+		// @ts-ignore
+		plugins: defaultVitePlugins,
 
 		optimizeDeps: {
 			exclude: [
@@ -210,17 +220,56 @@ function handleChangeLog(userConfig: UserConfig<DefaultTheme.Config>) {
 	nav.push({ text: "更新日志", link: "/CHANGELOG.md" });
 }
 
-// function addTwoslashPlugin(userConfig: UserConfig<DefaultTheme.Config>) {
-// 	userConfig.markdown?.codeTransformers?.push(transformerTwoslash());
-// }
+const defaultRuanCatConfig: RuanCatConfig = {
+	plugins: {
+		llmstxt: true,
+		gitChangelog: true,
+		gitChangelogMarkdownSection: true,
+		vitePluginVercel: true,
+	},
+};
+
+/** 处理插件配置 */
+function handlePlugins(
+	//
+	userConfig: UserConfig<DefaultTheme.Config>,
+	ruanCatConfig: RuanCatConfig = defaultRuanCatConfig,
+) {
+	let resPlugins: PluginOption[] = [];
+
+	ruanCatConfig = merge({}, cloneDeep(defaultRuanCatConfig), ruanCatConfig);
+
+	if (ruanCatConfig?.plugins?.llmstxt) {
+		resPlugins.push(defaultLlmstxt);
+	}
+	if (ruanCatConfig?.plugins?.gitChangelog) {
+		resPlugins.push(defaultGitChangelog);
+	}
+	if (ruanCatConfig?.plugins?.gitChangelogMarkdownSection) {
+		resPlugins.push(defaultGitChangelogMarkdownSection);
+	}
+	if (ruanCatConfig?.plugins?.vitePluginVercel) {
+		// @ts-ignore
+		resPlugins.push(defaultVitePluginVercel);
+	}
+
+	// @ts-ignore
+	userConfig.vite.plugins = resPlugins;
+}
 
 /** 设置vitepress主配置 */
-export function setUserConfig(config?: UserConfig<DefaultTheme.Config>) {
+export function setUserConfig(
+	config?: UserConfig<DefaultTheme.Config>,
+	ruanCatConfig: RuanCatConfig = defaultRuanCatConfig,
+): UserConfig<DefaultTheme.Config> {
 	/** 最终的用户数据 */
 	const resUserConfig = merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
 
 	// 增加导航栏
 	handleChangeLog(resUserConfig);
 
+	// 设置插件
+	handlePlugins(resUserConfig, ruanCatConfig);
+
 	return resUserConfig;
 }

package/src/type.ts

@@ -0,0 +1,9 @@
+/** 阮喵喵针对文档行为的配置 */
+export interface RuanCatConfig {
+	plugins?: {
+		llmstxt?: boolean;
+		gitChangelog?: boolean;
+		gitChangelogMarkdownSection?: boolean;
+		vitePluginVercel?: boolean;
+	};
+}