From 37a080c78d5bd9eb7ab4eea07cb39cbfe649d43e Mon Sep 17 00:00:00 2001
From: Mister-Hope <mister-hope@outlook.com>
Date: Wed, 4 Jun 2025 17:49:47 +0800
Subject: [PATCH] refactor(plugin-markdown-preview): improve documentation and
 localization comments

---
 docs/plugins/markdown/markdown-preview.md      |  4 +---
 docs/zh/plugins/markdown/markdown-preview.md   | 12 ++++++------
 .../plugin-markdown-preview/src/node/index.ts  |  1 +
 .../src/node/markdownPreviewPlugin.ts          | 18 ++++++++++++++++++
 .../src/node/options.ts                        |  4 ++--
 .../src/shared/locales.ts                      |  4 +++-
 6 files changed, 31 insertions(+), 12 deletions(-)

diff --git a/docs/plugins/markdown/markdown-preview.md b/docs/plugins/markdown/markdown-preview.md
index 3fb38062e8..7b020b59ba 100644
--- a/docs/plugins/markdown/markdown-preview.md
+++ b/docs/plugins/markdown/markdown-preview.md
@@ -97,9 +97,7 @@ document.querySelector('body').innerText = 'Hello world!'
   }
   ```
 
-- Details:
-
-  Locales configuration for `<VPPreview>`.
+- Details: Locales configuration for `<VPPreview>`.
 
 ## Styles
 
diff --git a/docs/zh/plugins/markdown/markdown-preview.md b/docs/zh/plugins/markdown/markdown-preview.md
index e14b3d52df..e959680ca9 100644
--- a/docs/zh/plugins/markdown/markdown-preview.md
+++ b/docs/zh/plugins/markdown/markdown-preview.md
@@ -49,7 +49,7 @@ export default {
 ````md
 <VPPreview title="可选标题">
   <template #content>
-    <!-- 你的内容在这里  -->
+    <!-- 你的内容在这里 -->
 
     Hello world!
 
@@ -67,7 +67,7 @@ document.querySelector('body').innerText = 'Hello world!'
 
 <VPPreview title="可选标题">
   <template #content>
-    <!-- 你的内容在这里  -->
+    <!-- 你的内容在这里 -->
 
     Hello world!
 
@@ -91,15 +91,15 @@ document.querySelector('body').innerText = 'Hello world!'
   ```ts
   export interface MarkdownPreviewLocaleData {
     /**
-     * 切换代码按钮文本
+     * Toggle code button text
+     *
+     * 切换代码按钮文字
      */
     toggle: string
   }
   ```
 
-- 详细信息:
-
-  `<VPPreview>` 的多语言配置。
+- 详情：`<VPPreview>` 的本地化配置。
 
 ## 样式
 
diff --git a/plugins/markdown/plugin-markdown-preview/src/node/index.ts b/plugins/markdown/plugin-markdown-preview/src/node/index.ts
index d99937d843..d6a7d7e075 100644
--- a/plugins/markdown/plugin-markdown-preview/src/node/index.ts
+++ b/plugins/markdown/plugin-markdown-preview/src/node/index.ts
@@ -1,2 +1,3 @@
 export * from './markdownPreviewPlugin.js'
+export type * from './options.js'
 export * from './preview.js'
diff --git a/plugins/markdown/plugin-markdown-preview/src/node/markdownPreviewPlugin.ts b/plugins/markdown/plugin-markdown-preview/src/node/markdownPreviewPlugin.ts
index 919db0958a..9ceec1fee9 100644
--- a/plugins/markdown/plugin-markdown-preview/src/node/markdownPreviewPlugin.ts
+++ b/plugins/markdown/plugin-markdown-preview/src/node/markdownPreviewPlugin.ts
@@ -10,6 +10,24 @@ const PLUGIN_NAME = '@vuepress/plugin-markdown-preview'
 
 const __dirname = getDirname(import.meta.url)
 
+/**
+ * Markdown preview plugin
+ *
+ * Markdown 预览插件
+ *
+ * @param options - plugin options / 插件选项
+ *
+ * @example
+ * ```ts
+ * import { markdownPreviewPlugin } from '@vuepress/plugin-markdown-preview'
+ *
+ * export default {
+ *   plugins: [
+ *     markdownPreviewPlugin(),
+ *   ],
+ * }
+ * ```
+ */
 export const markdownPreviewPlugin =
   (options: MarkdownPreviewPluginOptions = {}): Plugin =>
   (app) => ({
diff --git a/plugins/markdown/plugin-markdown-preview/src/node/options.ts b/plugins/markdown/plugin-markdown-preview/src/node/options.ts
index 673a08ef51..0ee8b397c1 100644
--- a/plugins/markdown/plugin-markdown-preview/src/node/options.ts
+++ b/plugins/markdown/plugin-markdown-preview/src/node/options.ts
@@ -3,9 +3,9 @@ import type { MarkdownPreviewPluginLocaleData } from '../shared/index.js'
 
 export interface MarkdownPreviewPluginOptions {
   /**
-   * Localization config
+   * Localization config for preview component
    *
-   * 本地化配置
+   * 预览组件的本地化配置
    */
   locales?: LocaleConfig<MarkdownPreviewPluginLocaleData>
 }
diff --git a/plugins/markdown/plugin-markdown-preview/src/shared/locales.ts b/plugins/markdown/plugin-markdown-preview/src/shared/locales.ts
index 21929cd26c..31c02d4aaa 100644
--- a/plugins/markdown/plugin-markdown-preview/src/shared/locales.ts
+++ b/plugins/markdown/plugin-markdown-preview/src/shared/locales.ts
@@ -2,7 +2,9 @@ import type { ExactLocaleConfig } from '@vuepress/helper'
 
 export interface MarkdownPreviewPluginLocaleData {
   /**
-   * toggle code button text
+   * Toggle code button text
+   *
+   * 切换代码按钮文字
    */
   toggle: string
 }