@ruan-cat/vitepress-preset-config 0.0.2 → 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",
   // 侧边栏需要折叠
@@ -37,8 +38,8 @@ function setGenerateSidebar(options) {
   return generateSidebar(getMergeSidebarOptions(options));
 }
 var defaultUserConfig = {
-  title: "10wms\u524D\u7AEF\u7EC4\u6280\u672F\u6587\u6863",
-  description: "\u672C\u524D\u7AEF\u9879\u76EE\u5185\u7684\u7EC4\u4EF6\u4F7F\u7528\u3001api\u3001\u7C7B\u578B\u4EE5\u53CA\u4F7F\u7528\u6587\u6863",
+  title: "\u8BF7\u586B\u5199\u6709\u610F\u4E49\u7684\u6807\u9898",
+  description: "\u8BF7\u586B\u5199\u6709\u610F\u4E49\u7684\u63CF\u8FF0",
   lang: "zh",
   // 暂不需要
   // srcDir: "./src",
@@ -48,12 +49,7 @@ var defaultUserConfig = {
       provider: "local"
     },
     // https://vitepress.dev/reference/default-theme-config
-    nav: [
-      { text: "\u9996\u9875", link: "/" },
-      { text: "\u66F4\u65B0\u65E5\u5FD7", link: "/CHANGELOG.md" }
-      // TODO: 未来项目结束时，在此补充配置
-      // { text: "仓库地址", link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/dev/packages/docs-01-star" },
-    ],
+    nav: [{ text: "\u9996\u9875", link: "/" }],
     outline: {
       label: "\u672C\u9875\u76EE\u5F55",
       level: "deep"
@@ -63,7 +59,7 @@ var defaultUserConfig = {
     socialLinks: [
       {
         icon: "github",
-        link: "https://github.com/ruan-cat/vercel-monorepo-test/blob/dev/packages/docs-01-star/docs/index.md"
+        link: "https://github.com/ruan-cat"
       }
     ]
   },
@@ -101,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"
     }
   }
 };
@@ -115,10 +123,7 @@ function handleChangeLog(userConfig) {
     consola.error(` \u5F53\u524D\u7684\u7528\u6237\u914D\u7F6E\u4E3A\uFF1A `, userConfig);
     throw new Error(` nav \u9ED8\u8BA4\u63D0\u4F9B\u7684\u5BFC\u822A\u680F\u914D\u7F6E\u4E3A\u7A7A\u3002\u4E0D\u7B26\u5408\u9ED8\u8BA4\u914D\u7F6E\uFF0C\u8BF7\u68C0\u67E5\u3002 `);
   }
-  nav.push({
-    text: "\u53D8\u66F4\u65E5\u5FD7",
-    link: "/CHANGELOG.md"
-  });
+  nav.push({ text: "\u66F4\u65B0\u65E5\u5FD7", link: "/CHANGELOG.md" });
 }
 function setUserConfig(config) {
   const resUserConfig = merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);

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,8 +1,8 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
-  "homepage": "https://utils.ruancat6312.top",
+  "homepage": "https://vitepress-preset.ruancat6312.top",
   "types": "./src/config.mts",
   "main": "./src/config.mts",
   "dependencies": {
@@ -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/config.mts

@@ -2,6 +2,7 @@
 // import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "@ruan-cat/vitepress-preset-config/config";
 // @ts-ignore
 import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "../../src/config.mts";
+import { description } from "../../package.json";
 
 addChangelog2doc({
 	target: "./src",
@@ -13,7 +14,18 @@ addChangelog2doc({
 /**
  * 本文档的渲染配置
  */
-const thisDocUserConfig = setUserConfig();
+const thisDocUserConfig = setUserConfig({
+	title: "vitepress预设配置",
+	description,
+	themeConfig: {
+		socialLinks: [
+			{
+				icon: "github",
+				link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/main/packages/vitepress-preset-config",
+			},
+		],
+	},
+});
 // @ts-ignore
 thisDocUserConfig.themeConfig.sidebar = setGenerateSidebar({
 	documentRootPath: "./src",

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];
 
 /** 默认侧边栏配置 */
@@ -66,8 +68,8 @@ export function setGenerateSidebar(options?: VitePressSidebarOptions) {
 
 /** 默认用户配置 */
 const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
-	title: "10wms前端组技术文档",
-	description: "本前端项目内的组件使用、api、类型以及使用文档",
+	title: "请填写有意义的标题",
+	description: "请填写有意义的描述",
 
 	lang: "zh",
 	// 暂不需要
@@ -81,12 +83,7 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 		},
 
 		// https://vitepress.dev/reference/default-theme-config
-		nav: [
-			{ text: "首页", link: "/" },
-			{ text: "更新日志", link: "/CHANGELOG.md" },
-			// TODO: 未来项目结束时，在此补充配置
-			// { text: "仓库地址", link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/dev/packages/docs-01-star" },
-		],
+		nav: [{ text: "首页", link: "/" }],
 
 		outline: {
 			label: "本页目录",
@@ -99,7 +96,7 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 		socialLinks: [
 			{
 				icon: "github",
-				link: "https://github.com/ruan-cat/vercel-monorepo-test/blob/dev/packages/docs-01-star/docs/index.md",
+				link: "https://github.com/ruan-cat",
 			},
 		],
 	},
@@ -145,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: "详情",
+		},
 	},
 };
 
@@ -169,12 +180,13 @@ function handleChangeLog(userConfig: UserConfig<DefaultTheme.Config>) {
 		throw new Error(` nav 默认提供的导航栏配置为空。不符合默认配置，请检查。 `);
 	}
 
-	nav.push({
-		text: "变更日志",
-		link: "/CHANGELOG.md",
-	});
+	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>) {
 	/** 最终的用户数据 */