Interface: ValaxyExtendConfig

Defined in: packages/valaxy/node/types/config.ts:76

Properties

addons?

optional addons?: ValaxyAddons;

Defined in: packages/valaxy/node/types/config.ts:374

En

Addons system

Zh

插件系统

See

为什么需要插件？ Why Addon? | Valaxy
插件橱窗 Addons Gallery | Valaxy

Example

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(),
  ]
})

build

build: object;

Defined in: packages/valaxy/node/types/config.ts:91

options for valaxy build

foucGuard?

optional foucGuard?: object;

En

FOUC (Flash of Unstyled Content) guard configuration. Prevents layout shift on first paint by hiding the page body until full CSS is loaded. Uses body { opacity: 0 } inline, then the main stylesheet sets body { opacity: 1 } to reveal content.

Zh

FOUC（无样式内容闪烁）防护配置。通过在完整 CSS 加载前隐藏页面内容来防止首屏样式闪烁。内联 body { opacity: 0 }，完整 CSS 加载后通过 body { opacity: 1 } 解锁显示。

foucGuard.enabled?

optional enabled?: boolean;

En

Enable FOUC guard. When disabled, no opacity hiding or fallback scripts will be injected.

Zh

是否启用 FOUC 防护。禁用后不会注入 opacity 隐藏及兜底脚本。

Default

true

foucGuard.maxDuration?

optional maxDuration?: number;

En

Maximum wait time (ms) before force-showing the page, as a safety fallback in case CSS fails to load. Set to 0 to disable the timeout fallback (only window.onload will trigger reveal).

Zh

最大等待时间（毫秒），作为 CSS 加载失败时的安全兜底。设置为 0 可禁用超时兜底（仅依赖 window.onload 触发显示）。

Default

ignoreDeadLinks?

optional ignoreDeadLinks?: 
  | boolean
  | "localhostLinks"
  | (string | RegExp | ((link) => boolean))[];

Don't fail builds due to dead links.

Zh

忽略死链

Default

false

ssg?

optional ssg?: object;

SSG (Static Site Generation) configuration.

ssg.engine?

optional engine?: "valaxy" | "vite-ssg";

En

SSG engine to use.

'valaxy': Built-in engine, no JSDOM dependency. (recommended)
'vite-ssg': Legacy engine based on vite-ssg / JSDOM.

Can be overridden by CLI flag --ssg-engine.

Zh

使用的 SSG 引擎。

'valaxy'：内置引擎，无 JSDOM 依赖。（推荐）
'vite-ssg'：基于 vite-ssg / JSDOM 的旧版引擎。

可通过 CLI 参数 --ssg-engine 覆盖。

Default

'valaxy'

ssgForPagination

ssgForPagination: 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

taxonomyI18n?

optional taxonomyI18n?: object;

En

Taxonomy i18n validation during valaxy dev / valaxy build. Checks whether translated tag.* / category.* keys are consistently defined across configured languages.

Zh

valaxy dev / valaxy build 期间的 taxonomy i18n 校验。用于检查 tag.* / category.* 翻译 key 是否在已配置语言中保持一致。

taxonomyI18n.level?

optional level?: "off" | "error" | "warn";

En

Validation level for taxonomy i18n checks.

'off': disable checks
'warn': print warnings and continue
'error': fail validation after reporting all issues

Zh

taxonomy i18n 校验级别。

'off'：关闭检查
'warn'：输出 warning 并继续流程
'error'：输出所有问题后以错误结束

Default

'warn'

cdn?

optional cdn?: object;

Defined in: packages/valaxy/node/types/config.ts:390

Experimental

CDN externals configuration. Specify modules to load from CDN instead of bundling them. Only takes effect during valaxy build, not in dev mode.

modules?

optional modules?: CdnModule[];

Modules to load from CDN instead of bundling

Default

[]

See

https://github.com/YunYouJun/valaxy/issues/604

components?

optional components?: Options;

Defined in: packages/valaxy/node/types/config.ts:287

See

https://github.com/unplugin/unplugin-vue-components

exclude

Default

components/.exclude

deploy

deploy: object;

Defined in: packages/valaxy/node/types/config.ts:190

Experimental

Deploy to gh-pages/remote server

type?

optional type?: "gh-pages" | "remote";

Zh

部署类型

En

deploy type

devtools?

optional devtools?: boolean;

Defined in: packages/valaxy/node/types/config.ts:338

Experimental

Enable Vue Devtools & Valaxy Devtools

See

https://devtools-next.vuejs.org/

extendMd?

optional extendMd?: (ctx) => void;

Defined in: packages/valaxy/node/types/config.ts:349

Parameters

ctx

content

string

data

Readonly<Record<string, any>>

excerpt?

string

path

string

route

EditableTreeNode

Returns

void

En

Extend markdown, you can modify the markdown content/excerpt

Zh

扩展 markdown

features

features: object;

Defined in: packages/valaxy/node/types/config.ts:225

Markdown Feature

katex

katex: boolean;

enable katex for global

true (default): all pages render KaTeX, unless frontmatter.katex: false
false: no pages render KaTeX by default, but individual pages can opt-in via frontmatter.katex: true

See

Default

true

fuse?

optional fuse?: object;

Defined in: packages/valaxy/node/types/config.ts:323

extendKeys?

optional extendKeys?: string[];

@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

groupIcons?

optional groupIcons?: Partial<Options>;

Defined in: packages/valaxy/node/types/config.ts:308

See

https://github.com/yuyinws/vitepress-plugin-group-icons

hooks?

optional hooks?: Partial<ValaxyHooks>;

Defined in: packages/valaxy/node/types/config.ts:381

En

Hooks system, you can customize each stage of the lifecycle.

Zh

钩子系统，你可以对生命周期的各个阶段进行定制。

See

https://valaxy.site/guide/custom/hooks

ignoreDeadLinks?

optional ignoreDeadLinks?: 
  | boolean
  | "localhostLinks"
  | (string | RegExp | ((link) => boolean))[];

Defined in: packages/valaxy/node/types/config.ts:83

Don't fail builds due to dead links.

Default

false

Deprecated

use build.ignoreDeadLinks instead

layouts?

optional layouts?: Partial<Options>;

Defined in: packages/valaxy/node/types/config.ts:291

See

https://github.com/loicduong/vite-plugin-vue-layouts-next

loaders?

optional loaders?: ContentLoader[];

Defined in: packages/valaxy/node/types/config.ts:405

Experimental

Content loaders for fetching content from external CMS platforms. Loaded content is written as .md files to .valaxy/content/pages/ and automatically integrated into the routing and markdown pipeline.

See

https://github.com/YunYouJun/valaxy/issues/294

markdown?

optional markdown?: MarkdownOptions & Options;

Defined in: packages/valaxy/node/types/config.ts:344

En

config for markdown (include markdown-it plugins)

Zh

markdown 相关配置 MarkdownOptions

math

math: boolean;

Defined in: packages/valaxy/node/types/config.ts:252

Enable MathJax3 math rendering (aligned with VitePress markdown.math).

When enabled, MathJax3 will be used via markdown-it-mathjax3 to render math formulas as self-contained SVG — no external CSS or fonts required.

features.katex and math are mutually exclusive.
When math is enabled, features.katex is automatically ignored.
math requires installing markdown-it-mathjax3: pnpm add markdown-it-mathjax3

See

https://www.mathjax.org/

Default

false

modules

modules: object;

Defined in: packages/valaxy/node/types/config.ts:201

internal modules

rss

rss: object;

rss.enable

enable: boolean;

enable rss

rss.extractImagePathsFromHTML

extractImagePathsFromHTML: boolean;

Zh

从构建后的 HTML 中提取图片路径（用于解析 Vite 打包后的 hash 文件名）

En

Extract image paths from built HTML files (to resolve Vite hashed filenames)

Default

true

rss.fullText

fullText: boolean;

Zh

全文输出

En

full text output

Default

false

router?

optional router?: Options;

Defined in: packages/valaxy/node/types/config.ts:295

See

https://router.vuejs.org/file-based-routing/

unocss?

optional unocss?: VitePluginConfig<object>;

Defined in: packages/valaxy/node/types/config.ts:299

See

https://unocss.dev/config/

unocssPresets?

optional unocssPresets?: object;

Defined in: packages/valaxy/node/types/config.ts:313

unocss presets

attributify?

optional attributify?: AttributifyOptions;

icons?

optional icons?: IconsOptions;

typography?

optional typography?: TypographyOptions<TypographyTheme>;

uno?

optional uno?: PresetWind4Options;

Deprecated

use wind4 instead

wind4?

optional wind4?: PresetWind4Options;

See

https://unocss.dev/guide/presets

visualizer?

optional visualizer?: PluginVisualizerOptions;

Defined in: packages/valaxy/node/types/config.ts:304

rollup-plugin-visualizer

See

https://github.com/btd/rollup-plugin-visualizer

vite?

optional vite?: UserConfig;

Defined in: packages/valaxy/node/types/config.ts:257

vite.config.ts options

See

https://vite.dev/

vue?

optional vue?: Options & object;

Defined in: packages/valaxy/node/types/config.ts:262

@vitejs/plugin-vue options

Type Declaration

browserTemplateCompilation?

optional browserTemplateCompilation?: boolean;

Valaxy

See

https://cn.vuejs.org/guide/scaling-up/tooling#note-on-in-browser-template-compilation enable

for runtime compile vue, encrypt and decrypt for excerpt_type: html (runtime render)

Default

true

browserTemplateCompilation

Description

支持浏览器内的模板编译

isCustomElement?

optional isCustomElement?: (tag) => boolean[];

Parameters

tag

string

Returns

boolean

Valaxy

See

https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/README.md

dayjs

Classes

Interfaces

Type Aliases

Variables

Functions

DefaultTheme

Interfaces

Interface: ValaxyExtendConfig ​

Properties ​

addons? ​

En ​

Zh ​

See ​

Example ​

build ​

foucGuard? ​

En ​

Zh ​

foucGuard.enabled? ​

En ​

Zh ​

Default ​

foucGuard.maxDuration? ​

En ​

Zh ​

Default ​

ignoreDeadLinks? ​

Zh ​

Default ​

ssg? ​

ssg.engine? ​

En ​

Zh ​

Default ​

ssgForPagination ​

En ​

Zh ​

Default ​

taxonomyI18n? ​

En ​

Zh ​

taxonomyI18n.level? ​

En ​

Zh ​

Default ​

cdn? ​

modules? ​

Default ​

See ​

components? ​

See ​

Default ​

deploy ​

type? ​

Zh ​

En ​

devtools? ​

See ​

extendMd? ​

Parameters ​

ctx ​

content ​

data ​

excerpt? ​

path ​

route ​

Returns ​

En ​

Zh ​

features ​

katex ​

See ​

Default ​

fuse? ​

extendKeys? ​

Default ​

groupIcons? ​

See ​

hooks? ​

Interface: ValaxyExtendConfig

Properties

addons?

En

Zh

See

Example

build

foucGuard?

En

Zh

foucGuard.enabled?

En

Zh

Default

foucGuard.maxDuration?

En

Zh

Default

ignoreDeadLinks?

Zh

Default

ssg?

ssg.engine?

En

Zh

Default

ssgForPagination

En

Zh

Default

taxonomyI18n?

En

Zh

taxonomyI18n.level?

En

Zh

Default

cdn?

modules?

Default

See

components?

See

Default

deploy

type?

Zh

En

devtools?

See

extendMd?

Parameters

ctx

content

data

excerpt?

path

route

Returns

En

Zh

features

katex

See

Default

fuse?

extendKeys?

Default

groupIcons?

See

hooks?

En

Zh

See

ignoreDeadLinks?

Default

Deprecated

layouts?

See