@ruan-cat/vitepress-preset-config 0.9.1 → 0.11.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ruan-cat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/config.d.mts

@@ -3,6 +3,7 @@ import { UserConfig, DefaultTheme } from 'vitepress';
 export { defineConfig } from 'vitepress';
 import { generateSidebar } from 'vitepress-sidebar';
 export { addChangelog2doc } from '@ruan-cat/utils/node-esm';
+export { withMermaid } from 'vitepress-plugin-mermaid';
 
 type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
 /**

package/dist/config.mjs

@@ -7,6 +7,8 @@ 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";
+import llmstxt from "vitepress-plugin-llms";
+import { withMermaid } from "vitepress-plugin-mermaid";
 var defaultSidebarOptions = {
   // documentRootPath: "src",
   // 侧边栏需要折叠
@@ -68,6 +70,9 @@ var defaultUserConfig = {
       open: true
     },
     plugins: [
+      /** @see https://github.com/okineadev/vitepress-plugin-llms */
+      // @ts-ignore
+      llmstxt(),
       // @ts-ignore
       GitChangelog({
         // 填写在此处填写您的仓库链接
@@ -136,5 +141,6 @@ export {
   addChangelog2doc,
   defineConfig,
   setGenerateSidebar,
-  setUserConfig
+  setUserConfig,
+  withMermaid
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "0.9.1",
+  "version": "0.11.0",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
   "homepage": "https://vitepress-preset.ruancat6312.top",
   "types": "./src/config.mts",
@@ -14,10 +14,13 @@
     "consola": "^3.4.0",
     "js-yaml": "^4.1.0",
     "lodash-es": "^4.17.21",
+    "mermaid": "^11.6.0",
     "vitepress-demo-plugin": "^1.3.1",
+    "vitepress-plugin-llms": "^1.1.0",
+    "vitepress-plugin-mermaid": "^2.0.17",
     "vitepress-sidebar": "^1.31.1",
     "vue": "^3.5.13",
-    "@ruan-cat/utils": "^4.2.2"
+    "@ruan-cat/utils": "^4.3.0"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",

package/src/config.mts

@@ -14,6 +14,20 @@ export { addChangelog2doc };
 
 import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 
+import llmstxt from "vitepress-plugin-llms";
+
+/**
+ * 让vitepress支持mermaid图表
+ * @see https://emersonbottero.github.io/vitepress-plugin-mermaid/guide/getting-started.html
+ */
+import { withMermaid } from "vitepress-plugin-mermaid";
+/**
+ * 不考虑这种二次包装的写法
+ * 本库仅仅是负责二次导出该函数
+ * mermaid 需求并不是常用的需求 故设计成让用户自己二次包装使用
+ */
+export { withMermaid };
+
 type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
 
 /** 默认侧边栏配置 */
@@ -107,6 +121,10 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 		},
 
 		plugins: [
+			/** @see https://github.com/okineadev/vitepress-plugin-llms */
+			// @ts-ignore
+			llmstxt(),
+
 			// @ts-ignore
 			GitChangelog({
 				// 填写在此处填写您的仓库链接