@ruan-cat/vitepress-preset-config 0.0.3 → 0.1.0

package/dist/config.mjs

@@ -6,6 +6,7 @@ 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 { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 var defaultSidebarOptions = {
   // documentRootPath: "src",
   // 侧边栏需要折叠
@@ -96,6 +97,18 @@ var defaultUserConfig = {
   markdown: {
     config(md) {
       md.use(vitepressDemoPlugin);
+    },
+    codeTransformers: [
+      // @ts-ignore FIXME: 这里出现奇怪的类型报错 屏蔽了
+      transformerTwoslash()
+    ],
+    // languages: ["js", "jsx", "ts", "tsx"],
+    container: {
+      tipLabel: "\u63D0\u793A",
+      warningLabel: "\u8B66\u544A",
+      dangerLabel: "\u5371\u9669",
+      infoLabel: "\u4FE1\u606F",
+      detailsLabel: "\u8BE6\u60C5"
     }
   }
 };

package/dist/theme/index.d.mts

@@ -1,15 +1,15 @@
-import * as vitepress from 'vitepress';
 import * as vue from 'vue';
+import { EnhanceAppContext } from 'vitepress';
 
 declare const theme: {
     extends: {
         Layout: vue.DefineComponent;
-        enhanceApp: (ctx: vitepress.EnhanceAppContext) => void;
+        enhanceApp: (ctx: EnhanceAppContext) => void;
     };
     Layout: () => vue.VNode<vue.RendererNode, vue.RendererElement, {
         [key: string]: any;
     }>;
-    enhanceApp({ app, router, siteData }: vitepress.EnhanceAppContext): void;
+    enhanceApp({ app, router, siteData }: EnhanceAppContext): void;
 };
 
 export { theme as default };

package/dist/theme/index.mjs

@@ -13,6 +13,8 @@ import { NolebaseHighlightTargetedHeading } from "@nolebase/vitepress-plugin-hig
 import "@nolebase/vitepress-plugin-highlight-targeted-heading/client/style.css";
 import { NolebaseGitChangelogPlugin } from "@nolebase/vitepress-plugin-git-changelog/client";
 import "@nolebase/vitepress-plugin-git-changelog/client/style.css";
+import TwoslashFloatingVue from "@shikijs/vitepress-twoslash/client";
+import "@shikijs/vitepress-twoslash/style.css";
 var theme = {
   extends: DefaultTheme,
   Layout: () => {
@@ -27,6 +29,7 @@ var theme = {
   },
   enhanceApp({ app, router, siteData }) {
     app.use(NolebaseGitChangelogPlugin);
+    app.use(TwoslashFloatingVue);
     app.provide(InjectionKey, {
       layoutSwitch: {
         defaultMode: LayoutMode["BothWidthAdjustable"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
   "homepage": "https://vitepress-preset.ruancat6312.top",
   "types": "./src/config.mts",
@@ -10,6 +10,7 @@
     "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.15.1",
     "@nolebase/vitepress-plugin-git-changelog": "^2.15.1",
     "@nolebase/vitepress-plugin-highlight-targeted-heading": "^2.15.1",
+    "@shikijs/vitepress-twoslash": "^3.2.1",
     "consola": "^3.4.0",
     "js-yaml": "^4.1.0",
     "lodash-es": "^4.17.21",
@@ -81,9 +82,7 @@
   ],
   "scripts": {
     "docs:dev": "vitepress dev src --port 8080",
-    "do-build-docs": "vitepress build src",
-    "build:docs": "turbo do-build-docs",
-    "do-build": "tsup",
-    "build": "turbo do-build"
+    "build:docs": "vitepress build src",
+    "build": "tsup"
   }
 }

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

@@ -1,6 +1,6 @@
 // https://vitepress.dev/guide/custom-theme
 import { h } from "vue";
-import type { Theme } from "vitepress";
+import type { Theme, EnhanceAppContext } from "vitepress";
 import DefaultTheme from "vitepress/theme";
 import "./style.css";
 
@@ -23,6 +23,9 @@ import "@nolebase/vitepress-plugin-highlight-targeted-heading/client/style.css";
 import { NolebaseGitChangelogPlugin } from "@nolebase/vitepress-plugin-git-changelog/client";
 import "@nolebase/vitepress-plugin-git-changelog/client/style.css";
 
+import TwoslashFloatingVue from "@shikijs/vitepress-twoslash/client";
+import "@shikijs/vitepress-twoslash/style.css";
+
 const theme = {
 	extends: DefaultTheme,
 	Layout: () => {
@@ -38,10 +41,11 @@ const theme = {
 			"layout-top": () => [h(NolebaseHighlightTargetedHeading)],
 		});
 	},
-	enhanceApp({ app, router, siteData }) {
-		// ...
+	enhanceApp({ app, router, siteData }: EnhanceAppContext) {
 		app.use(NolebaseGitChangelogPlugin);
 
+		app.use(TwoslashFloatingVue);
+
 		app.provide(InjectionKey, {
 			layoutSwitch: {
 				defaultMode: LayoutMode["BothWidthAdjustable"],

package/src/config.mts

@@ -12,6 +12,8 @@ import consola from "consola";
 import { addChangelog2doc, hasChangelogMd } from "@ruan-cat/utils/node-esm";
 export { addChangelog2doc };
 
+import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
+
 type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
 
 /** 默认侧边栏配置 */
@@ -140,6 +142,20 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 		config(md) {
 			md.use(vitepressDemoPlugin);
 		},
+
+		codeTransformers: [
+			// @ts-ignore FIXME: 这里出现奇怪的类型报错 屏蔽了
+			transformerTwoslash(),
+		],
+		// languages: ["js", "jsx", "ts", "tsx"],
+
+		container: {
+			tipLabel: "提示",
+			warningLabel: "警告",
+			dangerLabel: "危险",
+			infoLabel: "信息",
+			detailsLabel: "详情",
+		},
 	},
 };
 
@@ -167,6 +183,10 @@ function handleChangeLog(userConfig: UserConfig<DefaultTheme.Config>) {
 	nav.push({ text: "更新日志", link: "/CHANGELOG.md" });
 }
 
+// function addTwoslashPlugin(userConfig: UserConfig<DefaultTheme.Config>) {
+// 	userConfig.markdown?.codeTransformers?.push(transformerTwoslash());
+// }
+
 /** 设置vitepress主配置 */
 export function setUserConfig(config?: UserConfig<DefaultTheme.Config>) {
 	/** 最终的用户数据 */