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

package/dist/config.mjs

@@ -6,6 +6,7 @@ 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 { copyOrDownloadAsMarkdownButtons } from "vitepress-plugin-llms";
 
 // src/config/plugins.ts
 import vitepressPluginLlmstxt from "vitepress-plugin-llms";
@@ -22,12 +23,12 @@ var defaultGitChangelogOptions = {
 function getPlugins(extraConfig) {
   const plugins = [];
   const {
-    llmstxt,
+    llmstxt: llmstxt2,
     gitChangelog = defaultGitChangelogOptions,
     gitChangelogMarkdownSection
   } = (extraConfig == null ? void 0 : extraConfig.plugins) || {};
-  if (!isFalse(llmstxt)) {
-    plugins.push(vitepressPluginLlmstxt(llmstxt));
+  if (!isFalse(llmstxt2)) {
+    plugins.push(vitepressPluginLlmstxt(llmstxt2));
   }
   if (!isFalse(gitChangelog)) {
     plugins.push(GitChangelog(gitChangelog));
@@ -45,13 +46,34 @@ function handlePlugins(userConfig, extraConfig) {
 import { defineTeekConfig } from "vitepress-theme-teek/config";
 import { merge, cloneDeep } from "lodash-es";
 var defaultTeekConfig = {
-  /** @see https://vp.teek.top/reference/config/global-config.html#sidebartrigger */
+  /**
+   * 启用侧边栏展开/折叠触发器
+   * @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,
+  /**
+   * 启用新版代码块
+   * @see https://vp.teek.top/reference/config/global-config.html#codeblock
+   */
+  codeBlock: {
+    enabled: true,
+    // 是否启用新版代码块
+    collapseHeight: 700,
+    // 超出高度后自动折叠，设置 true 则默认折叠，false 则默认不折叠
+    overlay: true,
+    // 代码块底部是否显示展开/折叠遮罩层
+    overlayHeight: 400,
+    // 当出现遮罩层时，指定代码块显示高度，当 overlay 为 true 时生效
+    langTextTransform: "lowercase",
+    // 语言文本显示样式，为 text-transform 的值:none, capitalize, lowercase, uppercase
+    copiedDone: (TkMessage) => TkMessage.success("\u590D\u5236\u6210\u529F\uFF01")
+    // 复制代码完成后的回调
+  },
   vitePlugins: {
     /**
      * 关闭 vitepress-plugin-permalink 插件
@@ -166,6 +188,7 @@ var defaultUserConfig = {
     config(md) {
       md.use(vitepressDemoPlugin);
       MermaidPlugin(md);
+      md.use(copyOrDownloadAsMarkdownButtons);
     },
     codeTransformers: [
       // @ts-ignore FIXME: 这里出现奇怪的类型报错 屏蔽了

package/dist/theme.mjs

@@ -3,6 +3,7 @@ import { NolebaseGitChangelogPlugin } from "@nolebase/vitepress-plugin-git-chang
 import "@nolebase/vitepress-plugin-git-changelog/client/style.css";
 import TwoslashFloatingVue from "@shikijs/vitepress-twoslash/client";
 import "@shikijs/vitepress-twoslash/style.css";
+import CopyOrDownloadAsMarkdownButtons from "vitepress-plugin-llms/vitepress-components/CopyOrDownloadAsMarkdownButtons.vue";
 import Teek from "vitepress-theme-teek";
 import "vitepress-theme-teek/index.css";
 import { Mermaid } from "@leelaa/vitepress-plugin-extended";
@@ -10,6 +11,7 @@ function defaultEnhanceAppPreset({ app, router, siteData }) {
   app.use(NolebaseGitChangelogPlugin);
   app.use(TwoslashFloatingVue);
   app.component("Mermaid", Mermaid);
+  app.component("CopyOrDownloadAsMarkdownButtons", CopyOrDownloadAsMarkdownButtons);
 }
 var defaultTheme = {
   extends: Teek,

package/package.json

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

package/src/config/teek.ts

@@ -9,7 +9,10 @@ import type { TeekConfigOptions, ExtraConfig } from "../types";
  * @see https://vp.teek.top/reference/config.html
  */
 export const defaultTeekConfig: TeekConfigOptions = {
-	/** @see https://vp.teek.top/reference/config/global-config.html#sidebartrigger */
+	/**
+	 * 启用侧边栏展开/折叠触发器
+	 * @see https://vp.teek.top/reference/config/global-config.html#sidebartrigger
+	 */
 	sidebarTrigger: true,
 
 	/**
@@ -18,6 +21,19 @@ export const defaultTeekConfig: TeekConfigOptions = {
 	 */
 	teekHome: false,
 
+	/**
+	 * 启用新版代码块
+	 * @see https://vp.teek.top/reference/config/global-config.html#codeblock
+	 */
+	codeBlock: {
+		enabled: true, // 是否启用新版代码块
+		collapseHeight: 700, // 超出高度后自动折叠，设置 true 则默认折叠，false 则默认不折叠
+		overlay: true, // 代码块底部是否显示展开/折叠遮罩层
+		overlayHeight: 400, // 当出现遮罩层时，指定代码块显示高度，当 overlay 为 true 时生效
+		langTextTransform: "lowercase", // 语言文本显示样式，为 text-transform 的值:none, capitalize, lowercase, uppercase
+		copiedDone: (TkMessage) => TkMessage.success("复制成功！"), // 复制代码完成后的回调
+	},
+
 	vitePlugins: {
 		/**
 		 * 关闭 vitepress-plugin-permalink 插件

package/src/config.mts

@@ -14,7 +14,7 @@ export { addChangelog2doc, copyReadmeMd };
 
 import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 
-import llmstxt from "vitepress-plugin-llms";
+import llmstxt, { copyOrDownloadAsMarkdownButtons } from "vitepress-plugin-llms";
 
 import { defaultTeekConfig, handleTeekConfig, handlePlugins } from "./config/index.ts";
 
@@ -137,6 +137,9 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 
 			// @ts-ignore
 			MermaidPlugin(md);
+
+			// @ts-ignore
+			md.use(copyOrDownloadAsMarkdownButtons);
 		},
 
 		codeTransformers: [

package/src/theme.ts

@@ -13,12 +13,16 @@ import "@nolebase/vitepress-plugin-git-changelog/client/style.css";
 import TwoslashFloatingVue from "@shikijs/vitepress-twoslash/client";
 import "@shikijs/vitepress-twoslash/style.css";
 
+/** @see https://github.com/okineadev/vitepress-plugin-llms/blob/main/README.md */
+// @ts-ignore FIXME: 该组件直接使用时没有故障的 但是tsup打包有故障 故忽略类型报错
+import CopyOrDownloadAsMarkdownButtons from "vitepress-plugin-llms/vitepress-components/CopyOrDownloadAsMarkdownButtons.vue";
+
 // https://vp.teek.top/guide/quickstart.html#teek-引入
 import Teek from "vitepress-theme-teek";
 import "vitepress-theme-teek/index.css";
 
 /** @see https://vitepress-ext.leelaa.cn/Mermaid.html#全局引入 */
-// @ts-ignore
+// @ts-ignore FIXME: 忽略类型导出的bug 避免tsup打包失败
 import { Mermaid } from "@leelaa/vitepress-plugin-extended";
 
 /**
@@ -44,6 +48,7 @@ function defaultEnhanceAppPreset({ app, router, siteData }: EnhanceAppContext) {
 	app.use(NolebaseGitChangelogPlugin);
 	app.use(TwoslashFloatingVue);
 	app.component("Mermaid", Mermaid);
+	app.component("CopyOrDownloadAsMarkdownButtons", CopyOrDownloadAsMarkdownButtons);
 	/**
 	 * 放弃全局注册demo展示组件
 	 * 在生产环境内使用peer对等依赖