valaxy 0.20.2 → 0.20.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -325,7 +325,7 @@ interface PostFrontMatter extends PageFrontMatter {
325
325
  wordCount: string;
326
326
  }
327
327
 
328
- interface FuseListItem {
328
+ interface FuseListItem extends Record<string, any> {
329
329
  title: string;
330
330
  excerpt?: string;
331
331
  author: string;
@@ -467,9 +467,13 @@ interface SiteConfig {
467
467
  */
468
468
  social: SocialLink[];
469
469
  /**
470
- * search
470
+ * @en search engine for your site
471
+ * @zh 搜索功能
471
472
  */
472
473
  search: {
474
+ /**
475
+ * @zh 是否启用
476
+ */
473
477
  enable: boolean;
474
478
  /**
475
479
  * Search Type
@@ -497,8 +501,11 @@ interface SiteConfig {
497
501
  */
498
502
  options: FuseOptions<FuseListItem> & {
499
503
  /**
504
+ * @en_US The fields to be searched.
505
+ * @zh_CN 搜索的字段
500
506
  * @default ['title', 'tags', 'categories', 'excerpt']
501
- * @description 搜索的字段
507
+ * @description:en-US List of keys that will be searched. This supports nested paths, weighted search, and searching in arrays of strings and objects
508
+ * @description:zh-CN 搜索将会涉及的字段列表,支持嵌套路径、加权搜索以及在字符串和对象数组中进行搜索
502
509
  * @see https://fusejs.io/api/options.html#keys
503
510
  */
504
511
  keys: FuseOptions<FuseListItem>['keys'];
@@ -520,6 +527,10 @@ interface SiteConfig {
520
527
  * @default 'https://unpkg.com/'
521
528
  */
522
529
  cdn: {
530
+ /**
531
+ * prefix for your third-party
532
+ * @default 'https://unpkg.com/'
533
+ */
523
534
  prefix: string;
524
535
  };
525
536
  /**
@@ -566,6 +577,9 @@ interface SiteConfig {
566
577
  * @default undefined 不显示内容
567
578
  */
568
579
  description?: string;
580
+ /**
581
+ * @zh 赞助方式
582
+ */
569
583
  methods: {
570
584
  name: string;
571
585
  url: string;
@@ -684,17 +698,26 @@ interface Pkg {
684
698
  [key: string]: any;
685
699
  }
686
700
  interface ValaxyConfig<ThemeConfig = DefaultTheme.Config> {
701
+ /**
702
+ * @en Site **info** config. This affects info displayed on the site, and is independent of themes.
703
+ * @zh 站点**信息**配置,这部分内容面向站点展示,且在不同主题中也是通用的格式
704
+ * @see [站点配置 | Valaxy](https://valaxy.site/guide/config#%E7%AB%99%E7%82%B9%E9%85%8D%E7%BD%AE)
705
+ * @see [Site Config | Valaxy](https://valaxy.site/guide/config#site-config)
706
+ */
687
707
  siteConfig: SiteConfig;
688
708
  /**
689
709
  * The name of theme
690
710
  * @description 主题名称
691
711
  * @see 主题橱窗 [Valaxy Themes Gallery](https://valaxy.site/themes/gallery)
692
712
  * @see 如何编写主题? [How to write a theme? | Valaxy](https://valaxy.site/themes/write)
713
+ * @see [默认 Yun 主题示例](https://yun.valaxy.site/)
693
714
  */
694
715
  theme: string;
695
716
  /**
696
717
  * The config of theme
718
+ * @zh 请参考对应主题的相关文档
697
719
  * @description 主题配置
720
+ * @see [默认 Yun 主题文档](https://github.com/YunYouJun/valaxy/blob/main/packages/valaxy-theme-yun/docs/README.md)
698
721
  */
699
722
  themeConfig: ThemeConfig & {
700
723
  pkg: Pkg;
@@ -325,7 +325,7 @@ interface PostFrontMatter extends PageFrontMatter {
325
325
  wordCount: string;
326
326
  }
327
327
 
328
- interface FuseListItem {
328
+ interface FuseListItem extends Record<string, any> {
329
329
  title: string;
330
330
  excerpt?: string;
331
331
  author: string;
@@ -467,9 +467,13 @@ interface SiteConfig {
467
467
  */
468
468
  social: SocialLink[];
469
469
  /**
470
- * search
470
+ * @en search engine for your site
471
+ * @zh 搜索功能
471
472
  */
472
473
  search: {
474
+ /**
475
+ * @zh 是否启用
476
+ */
473
477
  enable: boolean;
474
478
  /**
475
479
  * Search Type
@@ -497,8 +501,11 @@ interface SiteConfig {
497
501
  */
498
502
  options: FuseOptions<FuseListItem> & {
499
503
  /**
504
+ * @en_US The fields to be searched.
505
+ * @zh_CN 搜索的字段
500
506
  * @default ['title', 'tags', 'categories', 'excerpt']
501
- * @description 搜索的字段
507
+ * @description:en-US List of keys that will be searched. This supports nested paths, weighted search, and searching in arrays of strings and objects
508
+ * @description:zh-CN 搜索将会涉及的字段列表,支持嵌套路径、加权搜索以及在字符串和对象数组中进行搜索
502
509
  * @see https://fusejs.io/api/options.html#keys
503
510
  */
504
511
  keys: FuseOptions<FuseListItem>['keys'];
@@ -520,6 +527,10 @@ interface SiteConfig {
520
527
  * @default 'https://unpkg.com/'
521
528
  */
522
529
  cdn: {
530
+ /**
531
+ * prefix for your third-party
532
+ * @default 'https://unpkg.com/'
533
+ */
523
534
  prefix: string;
524
535
  };
525
536
  /**
@@ -566,6 +577,9 @@ interface SiteConfig {
566
577
  * @default undefined 不显示内容
567
578
  */
568
579
  description?: string;
580
+ /**
581
+ * @zh 赞助方式
582
+ */
569
583
  methods: {
570
584
  name: string;
571
585
  url: string;
@@ -684,17 +698,26 @@ interface Pkg {
684
698
  [key: string]: any;
685
699
  }
686
700
  interface ValaxyConfig<ThemeConfig = DefaultTheme.Config> {
701
+ /**
702
+ * @en Site **info** config. This affects info displayed on the site, and is independent of themes.
703
+ * @zh 站点**信息**配置,这部分内容面向站点展示,且在不同主题中也是通用的格式
704
+ * @see [站点配置 | Valaxy](https://valaxy.site/guide/config#%E7%AB%99%E7%82%B9%E9%85%8D%E7%BD%AE)
705
+ * @see [Site Config | Valaxy](https://valaxy.site/guide/config#site-config)
706
+ */
687
707
  siteConfig: SiteConfig;
688
708
  /**
689
709
  * The name of theme
690
710
  * @description 主题名称
691
711
  * @see 主题橱窗 [Valaxy Themes Gallery](https://valaxy.site/themes/gallery)
692
712
  * @see 如何编写主题? [How to write a theme? | Valaxy](https://valaxy.site/themes/write)
713
+ * @see [默认 Yun 主题示例](https://yun.valaxy.site/)
693
714
  */
694
715
  theme: string;
695
716
  /**
696
717
  * The config of theme
718
+ * @zh 请参考对应主题的相关文档
697
719
  * @description 主题配置
720
+ * @see [默认 Yun 主题文档](https://github.com/YunYouJun/valaxy/blob/main/packages/valaxy-theme-yun/docs/README.md)
698
721
  */
699
722
  themeConfig: ThemeConfig & {
700
723
  pkg: Pkg;
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkLFH2U2WQcjs = require('../../chunk-LFH2U2WQ.cjs');require('../../chunk-7EKNBB3E.cjs');exports.cli = _chunkLFH2U2WQcjs.V; exports.run = _chunkLFH2U2WQcjs.W;
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSEN6YL7Ycjs = require('../../chunk-SEN6YL7Y.cjs');require('../../chunk-7EKNBB3E.cjs');exports.cli = _chunkSEN6YL7Ycjs.V; exports.run = _chunkSEN6YL7Ycjs.W;
@@ -1,2 +1,2 @@
1
1
  import {createRequire as __createRequire} from 'module';var require=__createRequire(import.meta.url);
2
- import{V as a,W as b}from"../../chunk-N5526RM3.mjs";import"../../chunk-AUDFAOQV.mjs";export{a as cli,b as run};
2
+ import{V as a,W as b}from"../../chunk-RPJK52Q7.mjs";import"../../chunk-AUDFAOQV.mjs";export{a as cli,b as run};
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkLFH2U2WQcjs = require('../chunk-LFH2U2WQ.cjs');require('../chunk-7EKNBB3E.cjs');exports.ALL_ROUTE = _chunkLFH2U2WQcjs.e; exports.EXCERPT_SEPARATOR = _chunkLFH2U2WQcjs.b; exports.EXTERNAL_URL_RE = _chunkLFH2U2WQcjs.c; exports.PATHNAME_PROTOCOL_RE = _chunkLFH2U2WQcjs.d; exports.ViteValaxyPlugins = _chunkLFH2U2WQcjs.P; exports.build = _chunkLFH2U2WQcjs.Q; exports.cli = _chunkLFH2U2WQcjs.V; exports.createServer = _chunkLFH2U2WQcjs.U; exports.createValaxyLoader = _chunkLFH2U2WQcjs.O; exports.customElements = _chunkLFH2U2WQcjs.f; exports.defaultSiteConfig = _chunkLFH2U2WQcjs.r; exports.defaultValaxyConfig = _chunkLFH2U2WQcjs.v; exports.defaultViteConfig = _chunkLFH2U2WQcjs.g; exports.defineAddon = _chunkLFH2U2WQcjs.C; exports.defineConfig = _chunkLFH2U2WQcjs.x; exports.defineSiteConfig = _chunkLFH2U2WQcjs.s; exports.defineTheme = _chunkLFH2U2WQcjs.H; exports.defineUnoSetup = _chunkLFH2U2WQcjs.I; exports.defineValaxyAddon = _chunkLFH2U2WQcjs.B; exports.defineValaxyConfig = _chunkLFH2U2WQcjs.w; exports.defineValaxyTheme = _chunkLFH2U2WQcjs.G; exports.ensurePrefix = _chunkLFH2U2WQcjs.l; exports.generateClientRedirects = _chunkLFH2U2WQcjs.T; exports.getGitTimestamp = _chunkLFH2U2WQcjs.a; exports.getIndexHtml = _chunkLFH2U2WQcjs.N; exports.isExternal = _chunkLFH2U2WQcjs.j; exports.isInstalledGlobally = _chunkLFH2U2WQcjs.h; exports.isPath = _chunkLFH2U2WQcjs.n; exports.loadConfig = _chunkLFH2U2WQcjs.p; exports.loadConfigFromFile = _chunkLFH2U2WQcjs.q; exports.mergeValaxyConfig = _chunkLFH2U2WQcjs.z; exports.mergeViteConfigs = _chunkLFH2U2WQcjs.M; exports.postProcessForSSG = _chunkLFH2U2WQcjs.S; exports.processValaxyOptions = _chunkLFH2U2WQcjs.J; exports.resolveAddonsConfig = _chunkLFH2U2WQcjs.D; exports.resolveImportPath = _chunkLFH2U2WQcjs.i; exports.resolveOptions = _chunkLFH2U2WQcjs.K; exports.resolveSiteConfig = _chunkLFH2U2WQcjs.u; exports.resolveSiteConfigFromRoot = _chunkLFH2U2WQcjs.t; exports.resolveThemeConfigFromRoot = _chunkLFH2U2WQcjs.E; exports.resolveThemeValaxyConfig = _chunkLFH2U2WQcjs.L; exports.resolveUserThemeConfig = _chunkLFH2U2WQcjs.F; exports.resolveValaxyConfig = _chunkLFH2U2WQcjs.A; exports.resolveValaxyConfigFromRoot = _chunkLFH2U2WQcjs.y; exports.run = _chunkLFH2U2WQcjs.W; exports.slash = _chunkLFH2U2WQcjs.k; exports.ssgBuild = _chunkLFH2U2WQcjs.R; exports.toAtFS = _chunkLFH2U2WQcjs.m; exports.transformObject = _chunkLFH2U2WQcjs.o;
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSEN6YL7Ycjs = require('../chunk-SEN6YL7Y.cjs');require('../chunk-7EKNBB3E.cjs');exports.ALL_ROUTE = _chunkSEN6YL7Ycjs.g; exports.EXCERPT_SEPARATOR = _chunkSEN6YL7Ycjs.d; exports.EXTERNAL_URL_RE = _chunkSEN6YL7Ycjs.e; exports.PATHNAME_PROTOCOL_RE = _chunkSEN6YL7Ycjs.f; exports.ViteValaxyPlugins = _chunkSEN6YL7Ycjs.P; exports.build = _chunkSEN6YL7Ycjs.Q; exports.cli = _chunkSEN6YL7Ycjs.V; exports.createServer = _chunkSEN6YL7Ycjs.U; exports.createValaxyLoader = _chunkSEN6YL7Ycjs.O; exports.customElements = _chunkSEN6YL7Ycjs.h; exports.defaultSiteConfig = _chunkSEN6YL7Ycjs.r; exports.defaultValaxyConfig = _chunkSEN6YL7Ycjs.v; exports.defaultViteConfig = _chunkSEN6YL7Ycjs.i; exports.defineAddon = _chunkSEN6YL7Ycjs.C; exports.defineConfig = _chunkSEN6YL7Ycjs.x; exports.defineSiteConfig = _chunkSEN6YL7Ycjs.s; exports.defineTheme = _chunkSEN6YL7Ycjs.H; exports.defineUnoSetup = _chunkSEN6YL7Ycjs.I; exports.defineValaxyAddon = _chunkSEN6YL7Ycjs.B; exports.defineValaxyConfig = _chunkSEN6YL7Ycjs.w; exports.defineValaxyTheme = _chunkSEN6YL7Ycjs.G; exports.ensurePrefix = _chunkSEN6YL7Ycjs.l; exports.generateClientRedirects = _chunkSEN6YL7Ycjs.T; exports.getGitTimestamp = _chunkSEN6YL7Ycjs.a; exports.getIndexHtml = _chunkSEN6YL7Ycjs.N; exports.isExternal = _chunkSEN6YL7Ycjs.j; exports.isInstalledGlobally = _chunkSEN6YL7Ycjs.b; exports.isPath = _chunkSEN6YL7Ycjs.n; exports.loadConfig = _chunkSEN6YL7Ycjs.p; exports.loadConfigFromFile = _chunkSEN6YL7Ycjs.q; exports.mergeValaxyConfig = _chunkSEN6YL7Ycjs.z; exports.mergeViteConfigs = _chunkSEN6YL7Ycjs.M; exports.postProcessForSSG = _chunkSEN6YL7Ycjs.S; exports.processValaxyOptions = _chunkSEN6YL7Ycjs.J; exports.resolveAddonsConfig = _chunkSEN6YL7Ycjs.D; exports.resolveImportPath = _chunkSEN6YL7Ycjs.c; exports.resolveOptions = _chunkSEN6YL7Ycjs.K; exports.resolveSiteConfig = _chunkSEN6YL7Ycjs.u; exports.resolveSiteConfigFromRoot = _chunkSEN6YL7Ycjs.t; exports.resolveThemeConfigFromRoot = _chunkSEN6YL7Ycjs.E; exports.resolveThemeValaxyConfig = _chunkSEN6YL7Ycjs.L; exports.resolveUserThemeConfig = _chunkSEN6YL7Ycjs.F; exports.resolveValaxyConfig = _chunkSEN6YL7Ycjs.A; exports.resolveValaxyConfigFromRoot = _chunkSEN6YL7Ycjs.y; exports.run = _chunkSEN6YL7Ycjs.W; exports.slash = _chunkSEN6YL7Ycjs.k; exports.ssgBuild = _chunkSEN6YL7Ycjs.R; exports.toAtFS = _chunkSEN6YL7Ycjs.m; exports.transformObject = _chunkSEN6YL7Ycjs.o;
@@ -24,7 +24,7 @@ import { SfcPluginOptions } from '@mdit-vue/plugin-sfc';
24
24
  import { TocPluginOptions } from '@mdit-vue/plugin-toc';
25
25
  import { Awaitable } from '@antfu/utils';
26
26
  import * as defu from 'defu';
27
- import { P as PartialDeep$1 } from '../config-BXn7sQx8.cjs';
27
+ import { P as PartialDeep$1 } from '../config-DfXD9Gt_.cjs';
28
28
  import 'yargs';
29
29
  import 'medium-zoom';
30
30
  import '@vueuse/integrations/useFuse';
@@ -310,6 +310,16 @@ interface ValaxyExtendConfig {
310
310
  icons?: Parameters<typeof presetIcons>[0];
311
311
  typography?: Parameters<typeof presetTypography>[0];
312
312
  };
313
+ fuse?: {
314
+ /**
315
+ * @en_US Extends the metadata fields returned by the search
316
+ * @zh_CN 扩展搜索返回的元数据字段
317
+ * @default []
318
+ * @description:en-US By default, returns the following fields: title, tags, categories, author, excerpt, link
319
+ * @description:zh-CN 默认返回以下字段:title、tags、categories、author、excerpt、link
320
+ */
321
+ extendKeys?: string[];
322
+ };
313
323
  /**
314
324
  * @experimental
315
325
  * Enable Vue Devtools & Valaxy Devtools
@@ -24,7 +24,7 @@ import { SfcPluginOptions } from '@mdit-vue/plugin-sfc';
24
24
  import { TocPluginOptions } from '@mdit-vue/plugin-toc';
25
25
  import { Awaitable } from '@antfu/utils';
26
26
  import * as defu from 'defu';
27
- import { P as PartialDeep$1 } from '../config-BXn7sQx8.js';
27
+ import { P as PartialDeep$1 } from '../config-DfXD9Gt_.js';
28
28
  import 'yargs';
29
29
  import 'medium-zoom';
30
30
  import '@vueuse/integrations/useFuse';
@@ -310,6 +310,16 @@ interface ValaxyExtendConfig {
310
310
  icons?: Parameters<typeof presetIcons>[0];
311
311
  typography?: Parameters<typeof presetTypography>[0];
312
312
  };
313
+ fuse?: {
314
+ /**
315
+ * @en_US Extends the metadata fields returned by the search
316
+ * @zh_CN 扩展搜索返回的元数据字段
317
+ * @default []
318
+ * @description:en-US By default, returns the following fields: title, tags, categories, author, excerpt, link
319
+ * @description:zh-CN 默认返回以下字段:title、tags、categories、author、excerpt、link
320
+ */
321
+ extendKeys?: string[];
322
+ };
313
323
  /**
314
324
  * @experimental
315
325
  * Enable Vue Devtools & Valaxy Devtools
@@ -1,2 +1,2 @@
1
1
  import {createRequire as __createRequire} from 'module';var require=__createRequire(import.meta.url);
2
- 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-N5526RM3.mjs";import"../chunk-AUDFAOQV.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};
2
+ 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-RPJK52Q7.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};
@@ -1,5 +1,5 @@
1
- import { a as PageFrontMatter, b as PostFrontMatter } from '../config-BXn7sQx8.cjs';
2
- 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-BXn7sQx8.cjs';
1
+ import { a as PageFrontMatter, b as PostFrontMatter } from '../config-DfXD9Gt_.cjs';
2
+ 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';
3
3
  import { Header } from '@valaxyjs/utils';
4
4
  import 'medium-zoom';
5
5
  import '@vueuse/integrations/useFuse';
@@ -1,5 +1,5 @@
1
- import { a as PageFrontMatter, b as PostFrontMatter } from '../config-BXn7sQx8.js';
2
- 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-BXn7sQx8.js';
1
+ import { a as PageFrontMatter, b as PostFrontMatter } from '../config-DfXD9Gt_.js';
2
+ 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';
3
3
  import { Header } from '@valaxyjs/utils';
4
4
  import 'medium-zoom';
5
5
  import '@vueuse/integrations/useFuse';
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "valaxy",
3
3
  "type": "module",
4
- "version": "0.20.2",
4
+ "version": "0.20.4",
5
5
  "description": "📄 Vite & Vue powered static blog generator.",
6
6
  "author": {
7
7
  "email": "me@yunyoujun.cn",
@@ -130,8 +130,8 @@
130
130
  "vue-i18n": "^10.0.4",
131
131
  "vue-router": "^4.4.5",
132
132
  "yargs": "^17.7.2",
133
- "@valaxyjs/devtools": "0.20.2",
134
- "@valaxyjs/utils": "0.20.2"
133
+ "@valaxyjs/devtools": "0.20.4",
134
+ "@valaxyjs/utils": "0.20.4"
135
135
  },
136
136
  "devDependencies": {
137
137
  "@mdit-vue/plugin-component": "^2.1.3",
@@ -152,10 +152,12 @@
152
152
  "@types/pascalcase": "^1.0.3",
153
153
  "@types/qrcode": "^1.5.5",
154
154
  "@types/yargs": "^17.0.33",
155
+ "cilicili": "^0.1.1",
155
156
  "diacritics": "^1.3.0",
156
157
  "gh-pages": "^6.2.0",
157
158
  "https-localhost": "^4.7.1",
158
- "rollup-plugin-visualizer": "^5.12.0"
159
+ "rollup-plugin-visualizer": "^5.12.0",
160
+ "table": "^6.8.2"
159
161
  },
160
162
  "scripts": {
161
163
  "build": "rimraf dist && tsup --splitting",
package/types/config.ts CHANGED
@@ -150,9 +150,13 @@ export interface SiteConfig {
150
150
  social: SocialLink[]
151
151
 
152
152
  /**
153
- * search
153
+ * @en search engine for your site
154
+ * @zh 搜索功能
154
155
  */
155
156
  search: {
157
+ /**
158
+ * @zh 是否启用
159
+ */
156
160
  enable: boolean
157
161
  /**
158
162
  * Search Type
@@ -181,8 +185,11 @@ export interface SiteConfig {
181
185
  */
182
186
  options: FuseOptions<FuseListItem> & {
183
187
  /**
188
+ * @en_US The fields to be searched.
189
+ * @zh_CN 搜索的字段
184
190
  * @default ['title', 'tags', 'categories', 'excerpt']
185
- * @description 搜索的字段
191
+ * @description:en-US List of keys that will be searched. This supports nested paths, weighted search, and searching in arrays of strings and objects
192
+ * @description:zh-CN 搜索将会涉及的字段列表,支持嵌套路径、加权搜索以及在字符串和对象数组中进行搜索
186
193
  * @see https://fusejs.io/api/options.html#keys
187
194
  */
188
195
  keys: FuseOptions<FuseListItem>['keys']
@@ -207,6 +214,10 @@ export interface SiteConfig {
207
214
  * @default 'https://unpkg.com/'
208
215
  */
209
216
  cdn: {
217
+ /**
218
+ * prefix for your third-party
219
+ * @default 'https://unpkg.com/'
220
+ */
210
221
  prefix: string
211
222
  }
212
223
 
@@ -255,6 +266,9 @@ export interface SiteConfig {
255
266
  * @default undefined 不显示内容
256
267
  */
257
268
  description?: string
269
+ /**
270
+ * @zh 赞助方式
271
+ */
258
272
  methods: {
259
273
  name: string
260
274
  url: string
@@ -389,17 +403,26 @@ export interface Pkg {
389
403
  }
390
404
 
391
405
  export interface ValaxyConfig<ThemeConfig = DefaultTheme.Config> {
406
+ /**
407
+ * @en Site **info** config. This affects info displayed on the site, and is independent of themes.
408
+ * @zh 站点**信息**配置,这部分内容面向站点展示,且在不同主题中也是通用的格式
409
+ * @see [站点配置 | Valaxy](https://valaxy.site/guide/config#%E7%AB%99%E7%82%B9%E9%85%8D%E7%BD%AE)
410
+ * @see [Site Config | Valaxy](https://valaxy.site/guide/config#site-config)
411
+ */
392
412
  siteConfig: SiteConfig
393
413
  /**
394
414
  * The name of theme
395
415
  * @description 主题名称
396
416
  * @see 主题橱窗 [Valaxy Themes Gallery](https://valaxy.site/themes/gallery)
397
417
  * @see 如何编写主题? [How to write a theme? | Valaxy](https://valaxy.site/themes/write)
418
+ * @see [默认 Yun 主题示例](https://yun.valaxy.site/)
398
419
  */
399
420
  theme: string
400
421
  /**
401
422
  * The config of theme
423
+ * @zh 请参考对应主题的相关文档
402
424
  * @description 主题配置
425
+ * @see [默认 Yun 主题文档](https://github.com/YunYouJun/valaxy/blob/main/packages/valaxy-theme-yun/docs/README.md)
403
426
  */
404
427
  themeConfig: ThemeConfig & {
405
428
  pkg: Pkg
package/types/node.ts CHANGED
@@ -1,4 +1,4 @@
1
- export interface FuseListItem {
1
+ export interface FuseListItem extends Record<string, any> {
2
2
  title: string
3
3
  excerpt?: string
4
4
  author: string