feat(theme): add hotReload options

vuepress-theme-hope · Nov 23, 2022 · adde3fe · adde3fe
1 parent dd66584
commit adde3fe
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 1 deletion.
diff --git a/docs/theme/src/config/plugins/blog.md b/docs/theme/src/config/plugins/blog.md
@@ -98,3 +98,10 @@ Star article list route path.
 - Default: `/timeline/`
 
 Timeline list route path.
+
+### hotReload
+
+- Type: `boolean`
+- Default: Whether using `--debug` flag
+
+Whether to enable hot reload in the development server.
diff --git a/docs/theme/src/ru/config/plugins/blog.md b/docs/theme/src/ru/config/plugins/blog.md
@@ -98,3 +98,10 @@ tag:
 - По умолчанию: `/timeline/`
 
 Путь маршрута списка временной шкалы.
+
+### hotReload
+
+- Type: `boolean`
+- Default: Whether using `--debug` flag
+
+Whether to enable hot reload in the development server.
diff --git a/docs/theme/src/zh/config/plugins/blog.md b/docs/theme/src/zh/config/plugins/blog.md
@@ -98,3 +98,10 @@ tag:
 - 默认值: `/timeline/`
 
 时间线列表路由路径。
+
+### hotReload
+
+- 类型: `boolean`
+- 默认值: 是否在使用 `--debug` 标识
+
+是否需要在开发服务器启用热更新。
diff --git a/packages/theme/src/node/plugins/blog.ts b/packages/theme/src/node/plugins/blog.ts
@@ -267,5 +267,7 @@ export const getBlogPlugin = (
         }),
       },
     ],
+
+    ...("hotReload" in blogOptions ? { hotReload: blogOptions.hotReload } : {}),
   });
 };
diff --git a/packages/theme/src/shared/options/plugins/blog.ts b/packages/theme/src/shared/options/plugins/blog.ts
@@ -1,7 +1,7 @@
 import type { BlogOptions } from "vuepress-plugin-blog2";
 
 export interface BlogPluginOptions
-  extends Partial<Pick<BlogOptions, "filter">> {
+  extends Partial<Pick<BlogOptions, "filter" | "hotReload">> {
   /**
    * Path of article list
    *