feat: support markdown options in markdown plugins

docs/.vuepress/config.ts

@@ -71,6 +71,11 @@ export default defineUserConfig({
         return importPath
       },
     },
+    image: {
+      figure: true,
+      mark: true,
+      size: true,
+    },
   },
 
   extendsMarkdown: (md) => {
@@ -91,11 +96,7 @@ export default defineUserConfig({
       json: true,
       rss: true,
     }),
-    markdownImagePlugin({
-      figure: true,
-      mark: true,
-      size: true,
-    }),
+    markdownImagePlugin(),
     markdownMathPlugin(),
     redirectPlugin({
       switchLocale: 'modal',

docs/plugins/markdown-image.md

@@ -14,8 +14,9 @@ npm i -D @vuepress/plugin-markdown-image@next
 import { markdownImagePlugin } from '@vuepress/plugin-markdown-image'
 
 export default {
-  plugins: [
-    markdownImagePlugin({
+  markdown: {
+    // config the plugin
+    image: {
       // Enable figure
       figure: true,
       // Enable image lazyload
@@ -24,7 +25,11 @@ export default {
       mark: true,
       // Enable image size
       size: true,
-    }),
+    },
+  },
+  plugins: [
+    // apply the plugin
+    markdownImagePlugin(),
   ],
 }
 ```
@@ -111,6 +116,8 @@ If the image is standalone in a line, wrapped or not wrapped by link, it will be
 
 ## Options
 
+You can set these options under `markdown.image` in your vuepress config file, or pass them to `markdownImagePlugin` directly. The latter has higher priority.
+
 ### figure
 
 - Type: `boolean`

docs/plugins/markdown-math.md

@@ -20,10 +20,15 @@ npm i -D katex
 import { markdownMathPlugin } from '@vuepress/plugin-markdown-math'
 
 export default {
-  plugins: [
-    markdownMathPlugin({
+  markdown: {
+    // config the plugin
+    math: {
       // options
-    }),
+    },
+  },
+  plugins: [
+    // apply the plugin
+    markdownMathPlugin(),
   ],
 }
 ```
@@ -92,6 +97,8 @@ Mathjax:
 
 ## Options
 
+You can set these options under `markdown.math` in your vuepress config file, or pass them to `markdownMathPlugin` directly. The latter has higher priority.
+
 ### type
 
 - Type: `'katex' | 'mathjax'`

docs/zh/plugins/markdown-image.md

@@ -14,8 +14,9 @@ npm i -D @vuepress/plugin-markdown-image@next
 import { markdownImagePlugin } from '@vuepress/plugin-markdown-image'
 
 export default {
-  plugins: [
-    markdownImagePlugin({
+  markdown: {
+    // 配置插件
+    image: {
       // 启用 figure
       figure: true,
       // 启用图片懒加载
@@ -24,7 +25,11 @@ export default {
       mark: true,
       // 启用图片大小
       size: true,
-    }),
+    },
+  },
+  plugins: [
+    // 应用插件
+    markdownImagePlugin(),
   ],
 }
 ```
@@ -111,6 +116,8 @@ interface ImageMarkOptions {
 
 ## 配置项
 
+你可以在 VuePress 配置文件中的 `markdown.image` 字段中配置此插件，也可以在调用时传入配置，后者具有更高优先级。
+
 ### figure
 
 - 类型：`boolean`

docs/zh/plugins/markdown-math.md

@@ -20,10 +20,15 @@ npm i -D katex
 import { markdownMathPlugin } from '@vuepress/plugin-markdown-math'
 
 export default {
-  plugins: [
-    markdownMathPlugin({
+  markdown: {
+    // 配置插件
+    math: {
       // 选项
-    }),
+    },
+  },
+  plugins: [
+    // 应用插件
+    markdownMathPlugin(),
   ],
 }
 ```
@@ -92,6 +97,8 @@ Mathjax:
 
 ## 配置项
 
+你可以在 VuePress 配置文件中的 `markdown.math` 字段中配置此插件，也可以在调用时传入配置，后者具有更高优先级。
+
 ### 类型
 
 - 类型：`'katex' | 'mathjax'`

plugins/plugin-markdown-image/package.json

@@ -32,6 +32,7 @@
   "exports": {
     ".": "./lib/node/index.js",
     "./client/*": "./lib/client/*",
+    "./types": "./lib/types.d.ts",
     "./package.json": "./package.json"
   },
   "main": "./lib/node/index.js",
@@ -40,7 +41,8 @@
     "lib"
   ],
   "scripts": {
-    "build": "tsc -b tsconfig.build.json",
+    "build": "tsc -b ./tsconfig.build.json",
+    "copy": "cpx \"src/types.d.ts\" lib",
     "clean": "rimraf --glob ./lib ./*.tsbuildinfo",
     "style": "sass src:lib --no-source-map"
   },

plugins/plugin-markdown-image/src/node/index.ts

@@ -1 +1,2 @@
 export * from './markdownImagePlugin.js'
+export * from './options.js'

plugins/plugin-markdown-image/src/node/markdownImagePlugin.ts

@@ -8,20 +8,24 @@ import type { MarkdownImagePluginOptions } from './options.js'
 import { prepareClientConfigFile } from './prepare/index.js'
 import { PLUGIN_NAME } from './utils.js'
 
-export const markdownImagePlugin = (
-  options: MarkdownImagePluginOptions,
-): Plugin => ({
-  name: PLUGIN_NAME,
+export const markdownImagePlugin =
+  (pluginOptions?: MarkdownImagePluginOptions): Plugin =>
+  (app) => {
+    const options = pluginOptions ?? app.options.markdown.image ?? {}
 
-  extendsMarkdown: (md) => {
-    const { mark } = options
+    return {
+      name: PLUGIN_NAME,
 
-    if (options.figure) md.use(figure)
-    if (options.lazyload) md.use(imgLazyload)
-    if (options.obsidianSize) md.use(obsidianImageSize)
-    if (options.size) md.use(imgSize)
-    if (mark) md.use(imgMark, isPlainObject(mark) ? mark : {})
-  },
+      extendsMarkdown: (md) => {
+        const { mark } = options
 
-  clientConfigFile: (app) => prepareClientConfigFile(app, options),
-})
+        if (options.figure) md.use(figure)
+        if (options.lazyload) md.use(imgLazyload)
+        if (options.obsidianSize) md.use(obsidianImageSize)
+        if (options.size) md.use(imgSize)
+        if (mark) md.use(imgMark, isPlainObject(mark) ? mark : {})
+      },
+
+      clientConfigFile: (app) => prepareClientConfigFile(app, options),
+    }
+  }

plugins/plugin-markdown-image/src/types.d.ts

@@ -0,0 +1,7 @@
+import type { MarkdownImagePluginOptions } from './node/options.js'
+
+declare module 'vuepress/markdown' {
+  export interface MarkdownOptions {
+    image?: MarkdownImagePluginOptions
+  }
+}

plugins/plugin-markdown-image/tsconfig.build.json

@@ -2,7 +2,10 @@
   "extends": "../../tsconfig.build.json",
   "compilerOptions": {
     "rootDir": "./src",
-    "outDir": "./lib"
+    "outDir": "./lib",
+    "paths": {
+      "@vuepress/markdown": ["./src/types.d.ts"]
+    }
   },
   "include": ["./src"]
 }

plugins/plugin-markdown-math/package.json

@@ -27,6 +27,7 @@
   "type": "module",
   "exports": {
     ".": "./lib/node/index.js",
+    "./types": "./lib/types.d.ts",
     "./package.json": "./package.json"
   },
   "main": "./lib/node/index.js",
@@ -37,6 +38,7 @@
   "scripts": {
     "build": "tsc -b tsconfig.build.json",
     "clean": "rimraf --glob ./lib ./*.tsbuildinfo",
+    "copy": "cpx \"src/types.d.ts\" lib",
     "style": "sass src:lib --no-source-map"
   },
   "dependencies": {

plugins/plugin-markdown-math/src/node/index.ts

@@ -1 +1,2 @@
 export * from './markdownMathPlugin.js'
+export * from './options.js'