Interface: ValaxyExtendConfig

Defined in: packages/valaxy/node/types.ts:54

Properties

addons?

optional addons: ValaxyAddons;

Defined in: packages/valaxy/node/types.ts:250

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

---

beastiesOptions?

optional beastiesOptions: Options;

Defined in: packages/valaxy/node/types.ts:263

beastiesOptions

See

https://github.com/danielroe/beasties

---

build

build: object;

Defined in: packages/valaxy/node/types.ts:69

options for valaxy build

ignoreDeadLinks?

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

Don't fail builds due to dead links.

Zh

忽略死链

Default

false

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

---

components?

optional components: Options;

Defined in: packages/valaxy/node/types.ts:163

See

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

exclude

Default

components/.exclude

---

deploy

deploy: object;

Defined in: packages/valaxy/node/types.ts:92

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.ts:214

Experimental

Enable Vue Devtools & Valaxy Devtools

See

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

---

extendMd()?

optional extendMd: (ctx) => void;

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

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.ts:121

Markdown Feature

katex

katex: boolean;

enable katex for global

See

• Example | Valaxy
• https://katex.org/

---

fuse?

optional fuse: object;

Defined in: packages/valaxy/node/types.ts:199

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.ts:184

See

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

---

hooks?

optional hooks: Partial<ValaxyHooks>;

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

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.ts:61

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.ts:167

See

https://github.com/JohnCampionJr/vite-plugin-vue-layouts

---

markdown?

optional markdown: MarkdownOptions & Options;

Defined in: packages/valaxy/node/types.ts:220

En

config for markdown (include markdown-it plugins)

Zh

markdown 相关配置 MarkdownOptions

---

modules

modules: object;

Defined in: packages/valaxy/node/types.ts:103

internal modules

rss

rss: object;

rss.enable

enable: boolean;

enable rss

rss.fullText

fullText: boolean;

Zh

全文输出

En

full text output

Default

false

---

router?

optional router: Options;

Defined in: packages/valaxy/node/types.ts:171

See

https://github.com/posva/unplugin-vue-router

---

unocss?

optional unocss: VitePluginConfig<object>;

Defined in: packages/valaxy/node/types.ts:175

See

https://unocss.dev/config/

---

unocssPresets?

optional unocssPresets: object;

Defined in: packages/valaxy/node/types.ts:189

unocss presets

attributify?

optional attributify: AttributifyOptions;

icons?

optional icons: IconsOptions;

typography?

optional typography: TypographyOptions;

uno?

optional uno: PresetUnoOptions;

Deprecated

use wind4 instead

wind4?

optional wind4: PresetWind4Options;

See

https://unocss.dev/guide/presets

---

visualizer?

optional visualizer: PluginVisualizerOptions;

Defined in: packages/valaxy/node/types.ts:180

rollup-plugin-visualizer

See

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

---

vite?

optional vite: UserConfig;

Defined in: packages/valaxy/node/types.ts:133

vite.config.ts options

See

https://vite.dev/

---

vue?

optional vue: Options & object;

Defined in: packages/valaxy/node/types.ts:138

@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