valaxy 0.20.1 → 0.20.3

package/dist/{config-DRImYfNf.d.cts → config-DfXD9Gt_.d.cts}

@@ -325,7 +325,7 @@ interface PostFrontMatter extends PageFrontMatter {
     wordCount: string;
 }
 
-interface FuseListItem {
+interface FuseListItem extends Record<string, any> {
     title: string;
     excerpt?: string;
     author: string;
@@ -377,6 +377,8 @@ interface SiteConfig {
     /**
      * alternative languages
      * @description 可选语言
+     * @en If you want to disable multi-language support for your site, you can set this to only include one language (e.g. `['en']`)
+     * @zh 如果你想要禁言站点的多语言支持，可以将此项设置为仅包含一个语言 (例如 `['zh-CN']`)
      * @default ['en', 'zh-CN']
      * @see https://ogp.me/#optional
      */
@@ -465,9 +467,13 @@ interface SiteConfig {
      */
     social: SocialLink[];
     /**
-     * search
+     * @en search engine for your site
+     * @zh 搜索功能
      */
     search: {
+        /**
+         * @zh 是否启用
+         */
         enable: boolean;
         /**
          * Search Type
@@ -495,8 +501,11 @@ interface SiteConfig {
          */
         options: FuseOptions<FuseListItem> & {
             /**
+             * @en_US The fields to be searched.
+             * @zh_CN 搜索的字段
              * @default ['title', 'tags', 'categories', 'excerpt']
-             * @description 搜索的字段
+             * @description:en-US List of keys that will be searched. This supports nested paths, weighted search, and searching in arrays of strings and objects
+             * @description:zh-CN 搜索将会涉及的字段列表，支持嵌套路径、加权搜索以及在字符串和对象数组中进行搜索
              * @see https://fusejs.io/api/options.html#keys
              */
             keys: FuseOptions<FuseListItem>['keys'];
@@ -518,6 +527,10 @@ interface SiteConfig {
      * @default 'https://unpkg.com/'
      */
     cdn: {
+        /**
+         * prefix for your third-party
+         * @default 'https://unpkg.com/'
+         */
         prefix: string;
     };
     /**
@@ -564,6 +577,9 @@ interface SiteConfig {
          * @default undefined 不显示内容
          */
         description?: string;
+        /**
+         * @zh 赞助方式
+         */
         methods: {
             name: string;
             url: string;
@@ -682,21 +698,33 @@ interface Pkg {
     [key: string]: any;
 }
 interface ValaxyConfig<ThemeConfig = DefaultTheme.Config> {
+    /**
+     * @en Site **info** config. This affects info displayed on the site, and is independent of themes.
+     * @zh 站点**信息**配置，这部分内容面向站点展示，且在不同主题中也是通用的格式
+     * @see [站点配置 | Valaxy](https://valaxy.site/guide/config#%E7%AB%99%E7%82%B9%E9%85%8D%E7%BD%AE)
+     * @see [Site Config | Valaxy](https://valaxy.site/guide/config#site-config)
+     */
     siteConfig: SiteConfig;
     /**
      * The name of theme
      * @description 主题名称
+     * @see 主题橱窗 [Valaxy Themes Gallery](https://valaxy.site/themes/gallery)
+     * @see 如何编写主题？ [How to write a theme? | Valaxy](https://valaxy.site/themes/write)
+     * @see [默认 Yun 主题示例](https://yun.valaxy.site/)
      */
     theme: string;
     /**
      * The config of theme
+     * @zh 请参考对应主题的相关文档
      * @description 主题配置
+     * @see [默认 Yun 主题文档](https://github.com/YunYouJun/valaxy/blob/main/packages/valaxy-theme-yun/docs/README.md)
      */
     themeConfig: ThemeConfig & {
         pkg: Pkg;
     };
     /**
-     * generated by runtime
+     * @en Generated in runtime, do not modify manually
+     * @zh 在运行时生成，请勿手动修改
      */
     runtimeConfig: RuntimeConfig;
 }

package/dist/{config-DRImYfNf.d.ts → config-DfXD9Gt_.d.ts}

@@ -325,7 +325,7 @@ interface PostFrontMatter extends PageFrontMatter {
     wordCount: string;
 }
 
-interface FuseListItem {
+interface FuseListItem extends Record<string, any> {
     title: string;
     excerpt?: string;
     author: string;
@@ -377,6 +377,8 @@ interface SiteConfig {
     /**
      * alternative languages
      * @description 可选语言
+     * @en If you want to disable multi-language support for your site, you can set this to only include one language (e.g. `['en']`)
+     * @zh 如果你想要禁言站点的多语言支持，可以将此项设置为仅包含一个语言 (例如 `['zh-CN']`)
      * @default ['en', 'zh-CN']
      * @see https://ogp.me/#optional
      */
@@ -465,9 +467,13 @@ interface SiteConfig {
      */
     social: SocialLink[];
     /**
-     * search
+     * @en search engine for your site
+     * @zh 搜索功能
      */
     search: {
+        /**
+         * @zh 是否启用
+         */
         enable: boolean;
         /**
          * Search Type
@@ -495,8 +501,11 @@ interface SiteConfig {
          */
         options: FuseOptions<FuseListItem> & {
             /**
+             * @en_US The fields to be searched.
+             * @zh_CN 搜索的字段
              * @default ['title', 'tags', 'categories', 'excerpt']
-             * @description 搜索的字段
+             * @description:en-US List of keys that will be searched. This supports nested paths, weighted search, and searching in arrays of strings and objects
+             * @description:zh-CN 搜索将会涉及的字段列表，支持嵌套路径、加权搜索以及在字符串和对象数组中进行搜索
              * @see https://fusejs.io/api/options.html#keys
              */
             keys: FuseOptions<FuseListItem>['keys'];
@@ -518,6 +527,10 @@ interface SiteConfig {
      * @default 'https://unpkg.com/'
      */
     cdn: {
+        /**
+         * prefix for your third-party
+         * @default 'https://unpkg.com/'
+         */
         prefix: string;
     };
     /**
@@ -564,6 +577,9 @@ interface SiteConfig {
          * @default undefined 不显示内容
          */
         description?: string;
+        /**
+         * @zh 赞助方式
+         */
         methods: {
             name: string;
             url: string;
@@ -682,21 +698,33 @@ interface Pkg {
     [key: string]: any;
 }
 interface ValaxyConfig<ThemeConfig = DefaultTheme.Config> {
+    /**
+     * @en Site **info** config. This affects info displayed on the site, and is independent of themes.
+     * @zh 站点**信息**配置，这部分内容面向站点展示，且在不同主题中也是通用的格式
+     * @see [站点配置 | Valaxy](https://valaxy.site/guide/config#%E7%AB%99%E7%82%B9%E9%85%8D%E7%BD%AE)
+     * @see [Site Config | Valaxy](https://valaxy.site/guide/config#site-config)
+     */
     siteConfig: SiteConfig;
     /**
      * The name of theme
      * @description 主题名称
+     * @see 主题橱窗 [Valaxy Themes Gallery](https://valaxy.site/themes/gallery)
+     * @see 如何编写主题？ [How to write a theme? | Valaxy](https://valaxy.site/themes/write)
+     * @see [默认 Yun 主题示例](https://yun.valaxy.site/)
      */
     theme: string;
     /**
      * The config of theme
+     * @zh 请参考对应主题的相关文档
      * @description 主题配置
+     * @see [默认 Yun 主题文档](https://github.com/YunYouJun/valaxy/blob/main/packages/valaxy-theme-yun/docs/README.md)
      */
     themeConfig: ThemeConfig & {
         pkg: Pkg;
     };
     /**
-     * generated by runtime
+     * @en Generated in runtime, do not modify manually
+     * @zh 在运行时生成，请勿手动修改
      */
     runtimeConfig: RuntimeConfig;
 }

package/dist/node/cli/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSHLDAAJYcjs = require('../../chunk-SHLDAAJY.cjs');require('../../chunk-SWO32WYT.cjs');exports.cli = _chunkSHLDAAJYcjs.V; exports.run = _chunkSHLDAAJYcjs.W;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk3BOTWUWTcjs = require('../../chunk-3BOTWUWT.cjs');require('../../chunk-7EKNBB3E.cjs');exports.cli = _chunk3BOTWUWTcjs.V; exports.run = _chunk3BOTWUWTcjs.W;

package/dist/node/cli/index.mjs

@@ -1,2 +1,2 @@
 import {createRequire as __createRequire} from 'module';var require=__createRequire(import.meta.url);
-import{V as a,W as b}from"../../chunk-G54Q6VIZ.mjs";import"../../chunk-FRSA4VPQ.mjs";export{a as cli,b as run};
+import{V as a,W as b}from"../../chunk-YHBMYDF7.mjs";import"../../chunk-AUDFAOQV.mjs";export{a as cli,b as run};

package/dist/node/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSHLDAAJYcjs = require('../chunk-SHLDAAJY.cjs');require('../chunk-SWO32WYT.cjs');exports.ALL_ROUTE = _chunkSHLDAAJYcjs.e; exports.EXCERPT_SEPARATOR = _chunkSHLDAAJYcjs.b; exports.EXTERNAL_URL_RE = _chunkSHLDAAJYcjs.c; exports.PATHNAME_PROTOCOL_RE = _chunkSHLDAAJYcjs.d; exports.ViteValaxyPlugins = _chunkSHLDAAJYcjs.P; exports.build = _chunkSHLDAAJYcjs.Q; exports.cli = _chunkSHLDAAJYcjs.V; exports.createServer = _chunkSHLDAAJYcjs.U; exports.createValaxyLoader = _chunkSHLDAAJYcjs.O; exports.customElements = _chunkSHLDAAJYcjs.f; exports.defaultSiteConfig = _chunkSHLDAAJYcjs.r; exports.defaultValaxyConfig = _chunkSHLDAAJYcjs.v; exports.defaultViteConfig = _chunkSHLDAAJYcjs.g; exports.defineAddon = _chunkSHLDAAJYcjs.C; exports.defineConfig = _chunkSHLDAAJYcjs.x; exports.defineSiteConfig = _chunkSHLDAAJYcjs.s; exports.defineTheme = _chunkSHLDAAJYcjs.H; exports.defineUnoSetup = _chunkSHLDAAJYcjs.I; exports.defineValaxyAddon = _chunkSHLDAAJYcjs.B; exports.defineValaxyConfig = _chunkSHLDAAJYcjs.w; exports.defineValaxyTheme = _chunkSHLDAAJYcjs.G; exports.ensurePrefix = _chunkSHLDAAJYcjs.l; exports.generateClientRedirects = _chunkSHLDAAJYcjs.T; exports.getGitTimestamp = _chunkSHLDAAJYcjs.a; exports.getIndexHtml = _chunkSHLDAAJYcjs.N; exports.isExternal = _chunkSHLDAAJYcjs.j; exports.isInstalledGlobally = _chunkSHLDAAJYcjs.h; exports.isPath = _chunkSHLDAAJYcjs.n; exports.loadConfig = _chunkSHLDAAJYcjs.p; exports.loadConfigFromFile = _chunkSHLDAAJYcjs.q; exports.mergeValaxyConfig = _chunkSHLDAAJYcjs.z; exports.mergeViteConfigs = _chunkSHLDAAJYcjs.M; exports.postProcessForSSG = _chunkSHLDAAJYcjs.S; exports.processValaxyOptions = _chunkSHLDAAJYcjs.J; exports.resolveAddonsConfig = _chunkSHLDAAJYcjs.D; exports.resolveImportPath = _chunkSHLDAAJYcjs.i; exports.resolveOptions = _chunkSHLDAAJYcjs.K; exports.resolveSiteConfig = _chunkSHLDAAJYcjs.u; exports.resolveSiteConfigFromRoot = _chunkSHLDAAJYcjs.t; exports.resolveThemeConfigFromRoot = _chunkSHLDAAJYcjs.E; exports.resolveThemeValaxyConfig = _chunkSHLDAAJYcjs.L; exports.resolveUserThemeConfig = _chunkSHLDAAJYcjs.F; exports.resolveValaxyConfig = _chunkSHLDAAJYcjs.A; exports.resolveValaxyConfigFromRoot = _chunkSHLDAAJYcjs.y; exports.run = _chunkSHLDAAJYcjs.W; exports.slash = _chunkSHLDAAJYcjs.k; exports.ssgBuild = _chunkSHLDAAJYcjs.R; exports.toAtFS = _chunkSHLDAAJYcjs.m; exports.transformObject = _chunkSHLDAAJYcjs.o;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk3BOTWUWTcjs = require('../chunk-3BOTWUWT.cjs');require('../chunk-7EKNBB3E.cjs');exports.ALL_ROUTE = _chunk3BOTWUWTcjs.g; exports.EXCERPT_SEPARATOR = _chunk3BOTWUWTcjs.d; exports.EXTERNAL_URL_RE = _chunk3BOTWUWTcjs.e; exports.PATHNAME_PROTOCOL_RE = _chunk3BOTWUWTcjs.f; exports.ViteValaxyPlugins = _chunk3BOTWUWTcjs.P; exports.build = _chunk3BOTWUWTcjs.Q; exports.cli = _chunk3BOTWUWTcjs.V; exports.createServer = _chunk3BOTWUWTcjs.U; exports.createValaxyLoader = _chunk3BOTWUWTcjs.O; exports.customElements = _chunk3BOTWUWTcjs.h; exports.defaultSiteConfig = _chunk3BOTWUWTcjs.r; exports.defaultValaxyConfig = _chunk3BOTWUWTcjs.v; exports.defaultViteConfig = _chunk3BOTWUWTcjs.i; exports.defineAddon = _chunk3BOTWUWTcjs.C; exports.defineConfig = _chunk3BOTWUWTcjs.x; exports.defineSiteConfig = _chunk3BOTWUWTcjs.s; exports.defineTheme = _chunk3BOTWUWTcjs.H; exports.defineUnoSetup = _chunk3BOTWUWTcjs.I; exports.defineValaxyAddon = _chunk3BOTWUWTcjs.B; exports.defineValaxyConfig = _chunk3BOTWUWTcjs.w; exports.defineValaxyTheme = _chunk3BOTWUWTcjs.G; exports.ensurePrefix = _chunk3BOTWUWTcjs.l; exports.generateClientRedirects = _chunk3BOTWUWTcjs.T; exports.getGitTimestamp = _chunk3BOTWUWTcjs.a; exports.getIndexHtml = _chunk3BOTWUWTcjs.N; exports.isExternal = _chunk3BOTWUWTcjs.j; exports.isInstalledGlobally = _chunk3BOTWUWTcjs.b; exports.isPath = _chunk3BOTWUWTcjs.n; exports.loadConfig = _chunk3BOTWUWTcjs.p; exports.loadConfigFromFile = _chunk3BOTWUWTcjs.q; exports.mergeValaxyConfig = _chunk3BOTWUWTcjs.z; exports.mergeViteConfigs = _chunk3BOTWUWTcjs.M; exports.postProcessForSSG = _chunk3BOTWUWTcjs.S; exports.processValaxyOptions = _chunk3BOTWUWTcjs.J; exports.resolveAddonsConfig = _chunk3BOTWUWTcjs.D; exports.resolveImportPath = _chunk3BOTWUWTcjs.c; exports.resolveOptions = _chunk3BOTWUWTcjs.K; exports.resolveSiteConfig = _chunk3BOTWUWTcjs.u; exports.resolveSiteConfigFromRoot = _chunk3BOTWUWTcjs.t; exports.resolveThemeConfigFromRoot = _chunk3BOTWUWTcjs.E; exports.resolveThemeValaxyConfig = _chunk3BOTWUWTcjs.L; exports.resolveUserThemeConfig = _chunk3BOTWUWTcjs.F; exports.resolveValaxyConfig = _chunk3BOTWUWTcjs.A; exports.resolveValaxyConfigFromRoot = _chunk3BOTWUWTcjs.y; exports.run = _chunk3BOTWUWTcjs.W; exports.slash = _chunk3BOTWUWTcjs.k; exports.ssgBuild = _chunk3BOTWUWTcjs.R; exports.toAtFS = _chunk3BOTWUWTcjs.m; exports.transformObject = _chunk3BOTWUWTcjs.o;

package/dist/node/index.d.cts

@@ -24,7 +24,7 @@ import { SfcPluginOptions } from '@mdit-vue/plugin-sfc';
 import { TocPluginOptions } from '@mdit-vue/plugin-toc';
 import { Awaitable } from '@antfu/utils';
 import * as defu from 'defu';
-import { P as PartialDeep$1 } from '../config-DRImYfNf.cjs';
+import { P as PartialDeep$1 } from '../config-DfXD9Gt_.cjs';
 import 'yargs';
 import 'medium-zoom';
 import '@vueuse/integrations/useFuse';
@@ -98,13 +98,14 @@ interface MarkdownOptions {
      *
      * You can also pass an object with `light` and `dark` themes to support dual themes.
      *
-     * @example { theme: 'github-dark' }
-     * @example { theme: { light: 'github-light', dark: 'github-dark' } }
+     * @see You can use an existing theme. https://shiki.style/themes
+     * @see Or add your own theme. https://shiki.style/guide/load-theme
      *
-     * You can use an existing theme.
-     * @see https://shiki.style/themes
-     * Or add your own theme.
-     * @see https://shiki.style/guide/load-theme
+     * @example { theme: 'github-dark' }
+     * @example light and dark themes
+     * ```js
+     * { theme: { light: 'github-light', dark: 'github-dark' } }
+     * ```
      */
     theme?: ThemeOptions;
     /**
@@ -209,18 +210,21 @@ interface ValaxyExtendConfig {
      * @deprecated use `build.ignoreDeadLinks` instead
      */
     ignoreDeadLinks?: boolean | 'localhostLinks' | (string | RegExp | ((link: string) => boolean))[];
+    /**
+     * options for `valaxy build`
+     */
     build: {
         /**
          * Don't fail builds due to dead links.
-         *
+         * @zh 忽略死链
          * @default false
          */
         ignoreDeadLinks?: boolean | 'localhostLinks' | (string | RegExp | ((link: string) => boolean))[];
         /**
          * Enable SSG for pagination
+         * @en When enabled, it will generate pagination pages for you. `/page/1`, `/page/2`, ...
+         * @zh 启用 SSG 分页，将单独构建分页页面 `/page/1`, `/page/2`, ...
          * @default false
-         * When enabled, it will generate pagination pages for you.
-         * `/page/1`, `/page/2`, ...
          */
         ssgForPagination: boolean;
     };
@@ -258,9 +262,15 @@ interface ValaxyExtendConfig {
     features: {
         /**
          * enable katex for global
+         * @see [Example | Valaxy](https://valaxy.site/examples/katex)
+         * @see https://katex.org/
          */
         katex: boolean;
     };
+    /**
+     * vite.config.ts options
+     * @see https://vite.dev/
+     */
     vite?: UserConfig;
     /**
      * @vitejs/plugin-vue options
@@ -269,9 +279,21 @@ interface ValaxyExtendConfig {
     vue?: Parameters<typeof Vue>[0] & {
         isCustomElement?: ((tag: string) => boolean)[];
     };
+    /**
+     * @see https://github.com/unplugin/unplugin-vue-components
+     */
     components?: Parameters<typeof Components>[0];
+    /**
+     * @see https://github.com/JohnCampionJr/vite-plugin-vue-layouts
+     */
     layouts?: Parameters<typeof Layouts>[0];
+    /**
+     * @see https://github.com/posva/unplugin-vue-router
+     */
     router?: Parameters<typeof Router>[0];
+    /**
+     * @see https://unocss.dev/config/
+     */
     unocss?: VitePluginConfig;
     /**
      * rollup-plugin-visualizer
@@ -280,6 +302,7 @@ interface ValaxyExtendConfig {
     visualizer?: PluginVisualizerOptions;
     /**
      * unocss presets
+     * @see https://unocss.dev/guide/presets
      */
     unocssPresets?: {
         uno?: Parameters<typeof presetUno>[0];
@@ -287,6 +310,16 @@ interface ValaxyExtendConfig {
         icons?: Parameters<typeof presetIcons>[0];
         typography?: Parameters<typeof presetTypography>[0];
     };
+    fuse?: {
+        /**
+         * @en_US Extends the metadata fields returned by the search
+         * @zh_CN 扩展搜索返回的元数据字段
+         * @default []
+         * @description:en-US By default, returns the following fields: title, tags, categories, author, excerpt, link
+         * @description:zh-CN 默认返回以下字段：title、tags、categories、author、excerpt、link
+         */
+        extendKeys?: string[];
+    };
     /**
      * @experimental
      * Enable Vue Devtools & Valaxy Devtools
@@ -294,9 +327,15 @@ interface ValaxyExtendConfig {
      */
     devtools?: boolean;
     /**
-     * for markdown
+     * @en config for markdown (include markdown-it plugins)
+     * @zh markdown 相关配置
+     * {@link MarkdownOptions}
      */
     markdown?: MarkdownOptions & Parameters<typeof Markdown>[0];
+    /**
+     * @en Extend markdown, you can modify the markdown content/excerpt
+     * @zh 扩展 markdown
+     */
     extendMd?: (ctx: {
         route: EditableTreeNode;
         data: Readonly<Record<string, any>>;
@@ -304,7 +343,30 @@ interface ValaxyExtendConfig {
         excerpt?: string;
         path: string;
     }) => void;
+    /**
+     * @en Addons system
+     * @zh 插件系统
+     * @see 为什么需要插件？ [Why Addon? | Valaxy](https://valaxy.site/addons/why)
+     * @see 插件橱窗 [Addons Gallery | Valaxy](https://valaxy.site/addons/gallery)
+     * @example
+     * ```ts
+     * import { defineValaxyConfig } from 'valaxy'
+     * import { addonTest } from 'valaxy-addon-test'
+     *
+     * export default defineValaxyConfig({
+     *   addons: [
+     *     // we always recommend to use function, so that you can pass options
+     *     addonTest(),
+     *   ]
+     * })
+     * ```
+     */
     addons?: ValaxyAddons;
+    /**
+     * @en Hooks system, you can customize each stage of the lifecycle.
+     * @zh 钩子系统，你可以对生命周期的各个阶段进行定制。
+     * @see https://valaxy.site/guide/custom/hooks
+     */
     hooks?: Partial<ValaxyHooks>;
 }
 type ValaxyAddonLike = ValaxyAddon | false | null | undefined;

package/dist/node/index.d.ts

@@ -24,7 +24,7 @@ import { SfcPluginOptions } from '@mdit-vue/plugin-sfc';
 import { TocPluginOptions } from '@mdit-vue/plugin-toc';
 import { Awaitable } from '@antfu/utils';
 import * as defu from 'defu';
-import { P as PartialDeep$1 } from '../config-DRImYfNf.js';
+import { P as PartialDeep$1 } from '../config-DfXD9Gt_.js';
 import 'yargs';
 import 'medium-zoom';
 import '@vueuse/integrations/useFuse';
@@ -98,13 +98,14 @@ interface MarkdownOptions {
      *
      * You can also pass an object with `light` and `dark` themes to support dual themes.
      *
-     * @example { theme: 'github-dark' }
-     * @example { theme: { light: 'github-light', dark: 'github-dark' } }
+     * @see You can use an existing theme. https://shiki.style/themes
+     * @see Or add your own theme. https://shiki.style/guide/load-theme
      *
-     * You can use an existing theme.
-     * @see https://shiki.style/themes
-     * Or add your own theme.
-     * @see https://shiki.style/guide/load-theme
+     * @example { theme: 'github-dark' }
+     * @example light and dark themes
+     * ```js
+     * { theme: { light: 'github-light', dark: 'github-dark' } }
+     * ```
      */
     theme?: ThemeOptions;
     /**
@@ -209,18 +210,21 @@ interface ValaxyExtendConfig {
      * @deprecated use `build.ignoreDeadLinks` instead
      */
     ignoreDeadLinks?: boolean | 'localhostLinks' | (string | RegExp | ((link: string) => boolean))[];
+    /**
+     * options for `valaxy build`
+     */
     build: {
         /**
          * Don't fail builds due to dead links.
-         *
+         * @zh 忽略死链
          * @default false
          */
         ignoreDeadLinks?: boolean | 'localhostLinks' | (string | RegExp | ((link: string) => boolean))[];
         /**
          * Enable SSG for pagination
+         * @en When enabled, it will generate pagination pages for you. `/page/1`, `/page/2`, ...
+         * @zh 启用 SSG 分页，将单独构建分页页面 `/page/1`, `/page/2`, ...
          * @default false
-         * When enabled, it will generate pagination pages for you.
-         * `/page/1`, `/page/2`, ...
          */
         ssgForPagination: boolean;
     };
@@ -258,9 +262,15 @@ interface ValaxyExtendConfig {
     features: {
         /**
          * enable katex for global
+         * @see [Example | Valaxy](https://valaxy.site/examples/katex)
+         * @see https://katex.org/
          */
         katex: boolean;
     };
+    /**
+     * vite.config.ts options
+     * @see https://vite.dev/
+     */
     vite?: UserConfig;
     /**
      * @vitejs/plugin-vue options
@@ -269,9 +279,21 @@ interface ValaxyExtendConfig {
     vue?: Parameters<typeof Vue>[0] & {
         isCustomElement?: ((tag: string) => boolean)[];
     };
+    /**
+     * @see https://github.com/unplugin/unplugin-vue-components
+     */
     components?: Parameters<typeof Components>[0];
+    /**
+     * @see https://github.com/JohnCampionJr/vite-plugin-vue-layouts
+     */
     layouts?: Parameters<typeof Layouts>[0];
+    /**
+     * @see https://github.com/posva/unplugin-vue-router
+     */
     router?: Parameters<typeof Router>[0];
+    /**
+     * @see https://unocss.dev/config/
+     */
     unocss?: VitePluginConfig;
     /**
      * rollup-plugin-visualizer
@@ -280,6 +302,7 @@ interface ValaxyExtendConfig {
     visualizer?: PluginVisualizerOptions;
     /**
      * unocss presets
+     * @see https://unocss.dev/guide/presets
      */
     unocssPresets?: {
         uno?: Parameters<typeof presetUno>[0];
@@ -287,6 +310,16 @@ interface ValaxyExtendConfig {
         icons?: Parameters<typeof presetIcons>[0];
         typography?: Parameters<typeof presetTypography>[0];
     };
+    fuse?: {
+        /**
+         * @en_US Extends the metadata fields returned by the search
+         * @zh_CN 扩展搜索返回的元数据字段
+         * @default []
+         * @description:en-US By default, returns the following fields: title, tags, categories, author, excerpt, link
+         * @description:zh-CN 默认返回以下字段：title、tags、categories、author、excerpt、link
+         */
+        extendKeys?: string[];
+    };
     /**
      * @experimental
      * Enable Vue Devtools & Valaxy Devtools
@@ -294,9 +327,15 @@ interface ValaxyExtendConfig {
      */
     devtools?: boolean;
     /**
-     * for markdown
+     * @en config for markdown (include markdown-it plugins)
+     * @zh markdown 相关配置
+     * {@link MarkdownOptions}
      */
     markdown?: MarkdownOptions & Parameters<typeof Markdown>[0];
+    /**
+     * @en Extend markdown, you can modify the markdown content/excerpt
+     * @zh 扩展 markdown
+     */
     extendMd?: (ctx: {
         route: EditableTreeNode;
         data: Readonly<Record<string, any>>;
@@ -304,7 +343,30 @@ interface ValaxyExtendConfig {
         excerpt?: string;
         path: string;
     }) => void;
+    /**
+     * @en Addons system
+     * @zh 插件系统
+     * @see 为什么需要插件？ [Why Addon? | Valaxy](https://valaxy.site/addons/why)
+     * @see 插件橱窗 [Addons Gallery | Valaxy](https://valaxy.site/addons/gallery)
+     * @example
+     * ```ts
+     * import { defineValaxyConfig } from 'valaxy'
+     * import { addonTest } from 'valaxy-addon-test'
+     *
+     * export default defineValaxyConfig({
+     *   addons: [
+     *     // we always recommend to use function, so that you can pass options
+     *     addonTest(),
+     *   ]
+     * })
+     * ```
+     */
     addons?: ValaxyAddons;
+    /**
+     * @en Hooks system, you can customize each stage of the lifecycle.
+     * @zh 钩子系统，你可以对生命周期的各个阶段进行定制。
+     * @see https://valaxy.site/guide/custom/hooks
+     */
     hooks?: Partial<ValaxyHooks>;
 }
 type ValaxyAddonLike = ValaxyAddon | false | null | undefined;

package/dist/node/index.mjs

@@ -1,2 +1,2 @@
 import {createRequire as __createRequire} from 'module';var require=__createRequire(import.meta.url);
-import{A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z}from"../chunk-G54Q6VIZ.mjs";import"../chunk-FRSA4VPQ.mjs";export{e as ALL_ROUTE,b as EXCERPT_SEPARATOR,c as EXTERNAL_URL_RE,d as PATHNAME_PROTOCOL_RE,P as ViteValaxyPlugins,Q as build,V as cli,U as createServer,O as createValaxyLoader,f as customElements,r as defaultSiteConfig,v as defaultValaxyConfig,g as defaultViteConfig,C as defineAddon,x as defineConfig,s as defineSiteConfig,H as defineTheme,I as defineUnoSetup,B as defineValaxyAddon,w as defineValaxyConfig,G as defineValaxyTheme,l as ensurePrefix,T as generateClientRedirects,a as getGitTimestamp,N as getIndexHtml,j as isExternal,h as isInstalledGlobally,n as isPath,p as loadConfig,q as loadConfigFromFile,z as mergeValaxyConfig,M as mergeViteConfigs,S as postProcessForSSG,J as processValaxyOptions,D as resolveAddonsConfig,i as resolveImportPath,K as resolveOptions,u as resolveSiteConfig,t as resolveSiteConfigFromRoot,E as resolveThemeConfigFromRoot,L as resolveThemeValaxyConfig,F as resolveUserThemeConfig,A as resolveValaxyConfig,y as resolveValaxyConfigFromRoot,W as run,k as slash,R as ssgBuild,m as toAtFS,o as transformObject};
+import{A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z}from"../chunk-YHBMYDF7.mjs";import"../chunk-AUDFAOQV.mjs";export{g as ALL_ROUTE,d as EXCERPT_SEPARATOR,e as EXTERNAL_URL_RE,f as PATHNAME_PROTOCOL_RE,P as ViteValaxyPlugins,Q as build,V as cli,U as createServer,O as createValaxyLoader,h as customElements,r as defaultSiteConfig,v as defaultValaxyConfig,i as defaultViteConfig,C as defineAddon,x as defineConfig,s as defineSiteConfig,H as defineTheme,I as defineUnoSetup,B as defineValaxyAddon,w as defineValaxyConfig,G as defineValaxyTheme,l as ensurePrefix,T as generateClientRedirects,a as getGitTimestamp,N as getIndexHtml,j as isExternal,b as isInstalledGlobally,n as isPath,p as loadConfig,q as loadConfigFromFile,z as mergeValaxyConfig,M as mergeViteConfigs,S as postProcessForSSG,J as processValaxyOptions,D as resolveAddonsConfig,c as resolveImportPath,K as resolveOptions,u as resolveSiteConfig,t as resolveSiteConfigFromRoot,E as resolveThemeConfigFromRoot,L as resolveThemeValaxyConfig,F as resolveUserThemeConfig,A as resolveValaxyConfig,y as resolveValaxyConfigFromRoot,W as run,k as slash,R as ssgBuild,m as toAtFS,o as transformObject};

package/dist/types/index.cjs

@@ -1 +1 @@
-"use strict";var _chunkSWO32WYTcjs = require('../chunk-SWO32WYT.cjs');_chunkSWO32WYTcjs.e.call(void 0, );_chunkSWO32WYTcjs.e.call(void 0, );_chunkSWO32WYTcjs.e.call(void 0, );_chunkSWO32WYTcjs.e.call(void 0, );_chunkSWO32WYTcjs.e.call(void 0, );_chunkSWO32WYTcjs.e.call(void 0, );_chunkSWO32WYTcjs.e.call(void 0, );_chunkSWO32WYTcjs.e.call(void 0, );_chunkSWO32WYTcjs.e.call(void 0, );_chunkSWO32WYTcjs.e.call(void 0, );
+"use strict";var _chunk7EKNBB3Ecjs = require('../chunk-7EKNBB3E.cjs');_chunk7EKNBB3Ecjs.e.call(void 0, );_chunk7EKNBB3Ecjs.e.call(void 0, );_chunk7EKNBB3Ecjs.e.call(void 0, );_chunk7EKNBB3Ecjs.e.call(void 0, );_chunk7EKNBB3Ecjs.e.call(void 0, );_chunk7EKNBB3Ecjs.e.call(void 0, );_chunk7EKNBB3Ecjs.e.call(void 0, );_chunk7EKNBB3Ecjs.e.call(void 0, );_chunk7EKNBB3Ecjs.e.call(void 0, );_chunk7EKNBB3Ecjs.e.call(void 0, );

package/dist/types/index.d.cts

@@ -1,5 +1,5 @@
-import { a as PageFrontMatter, b as PostFrontMatter } from '../config-DRImYfNf.cjs';
-export { A as Album, D as DefaultTheme, E as ExcerptType, F as FuseListItem, P as PartialDeep, i as Photo, f as Pkg, c as RedirectItem, R as RedirectRule, e as RuntimeConfig, d as SiteConfig, S as SocialLink, U as UserSiteConfig, h as UserValaxyConfig, V as ValaxyAddon, g as ValaxyConfig } from '../config-DRImYfNf.cjs';
+import { a as PageFrontMatter, b as PostFrontMatter } from '../config-DfXD9Gt_.cjs';
+export { A as Album, D as DefaultTheme, E as ExcerptType, F as FuseListItem, P as PartialDeep, i as Photo, f as Pkg, c as RedirectItem, R as RedirectRule, e as RuntimeConfig, d as SiteConfig, S as SocialLink, U as UserSiteConfig, h as UserValaxyConfig, V as ValaxyAddon, g as ValaxyConfig } from '../config-DfXD9Gt_.cjs';
 import { Header } from '@valaxyjs/utils';
 import 'medium-zoom';
 import '@vueuse/integrations/useFuse';

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-import { a as PageFrontMatter, b as PostFrontMatter } from '../config-DRImYfNf.js';
-export { A as Album, D as DefaultTheme, E as ExcerptType, F as FuseListItem, P as PartialDeep, i as Photo, f as Pkg, c as RedirectItem, R as RedirectRule, e as RuntimeConfig, d as SiteConfig, S as SocialLink, U as UserSiteConfig, h as UserValaxyConfig, V as ValaxyAddon, g as ValaxyConfig } from '../config-DRImYfNf.js';
+import { a as PageFrontMatter, b as PostFrontMatter } from '../config-DfXD9Gt_.js';
+export { A as Album, D as DefaultTheme, E as ExcerptType, F as FuseListItem, P as PartialDeep, i as Photo, f as Pkg, c as RedirectItem, R as RedirectRule, e as RuntimeConfig, d as SiteConfig, S as SocialLink, U as UserSiteConfig, h as UserValaxyConfig, V as ValaxyAddon, g as ValaxyConfig } from '../config-DfXD9Gt_.js';
 import { Header } from '@valaxyjs/utils';
 import 'medium-zoom';
 import '@vueuse/integrations/useFuse';

package/dist/types/index.mjs

@@ -1,2 +1,2 @@
 import {createRequire as __createRequire} from 'module';var require=__createRequire(import.meta.url);
-import{d as e}from"../chunk-FRSA4VPQ.mjs";e();e();e();e();e();e();e();e();e();e();
+import{d as e}from"../chunk-AUDFAOQV.mjs";e();e();e();e();e();e();e();e();e();e();