Valaxy API Docs

Appearance

Interface: ValaxyExtendConfig ​

Properties ​

addons? ​

optional addons: ValaxyAddons

En ​

Addons system

Zh ​

插件系统

See ​

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

Defined in ​

packages/valaxy/node/types.ts:218

build ​

build: object

options for valaxy build

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

Don't fail builds due to dead links.

Zh ​

忽略死链

Default ​
ts
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 ​
ts
false

Defined in ​

packages/valaxy/node/types.ts:64

components? ​

optional components: Options

See ​

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

Defined in ​

packages/valaxy/node/types.ts:139

deploy ​

deploy: object

Experimental

Deploy to gh-pages/remote server

type? ​

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

Experimental

Zh ​

部署类型

En ​

deploy type

Defined in ​

packages/valaxy/node/types.ts:87

devtools? ​

optional devtools: boolean

Experimental

Enable Vue Devtools & Valaxy Devtools

See ​

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

Defined in ​

packages/valaxy/node/types.ts:182

extendMd()? ​

optional extendMd: (ctx) => void

Parameters ​

• ctx

• ctx.content: string

• ctx.data: Readonly<Record<string, any>>

• ctx.excerpt?: string

• ctx.path: string

• ctx.route: EditableTreeNode

Returns ​

void

En ​

Extend markdown, you can modify the markdown content/excerpt

Zh ​

扩展 markdown

Defined in ​

packages/valaxy/node/types.ts:193

features ​

features: object

Markdown Feature

katex ​

katex: boolean

enable katex for global

See ​

Defined in ​

packages/valaxy/node/types.ts:116

fuse? ​

optional fuse: object

extendKeys? ​

optional extendKeys: string[]

@en_US Extends the metadata fields returned by the search @zh_CN 扩展搜索返回的元数据字段

Default ​
ts
[]
@description:en-US By default, returns the following fields: title, tags, categories, author, excerpt, link
@description:zh-CN 默认返回以下字段：title、tags、categories、author、excerpt、link

Defined in ​

packages/valaxy/node/types.ts:167

hooks? ​

optional hooks: Partial<ValaxyHooks>

En ​

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

Zh ​

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

See ​

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

Defined in ​

packages/valaxy/node/types.ts:225

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

Don't fail builds due to dead links.

Default ​

ts
false

Deprecated ​

use build.ignoreDeadLinks instead

Defined in ​

packages/valaxy/node/types.ts:56

layouts? ​

optional layouts: Partial<Options>

See ​

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

Defined in ​

packages/valaxy/node/types.ts:143

markdown? ​

optional markdown: MarkdownOptions & Options

En ​

config for markdown (include markdown-it plugins)

Zh ​

markdown 相关配置 MarkdownOptions

Defined in ​

packages/valaxy/node/types.ts:188

modules ​

modules: object

internal modules

rss ​

rss: object

rss.enable ​

enable: boolean

enable rss

rss.fullText ​

fullText: boolean

Zh ​

全文输出

En ​

full text output

Default ​
ts
false

Defined in ​

packages/valaxy/node/types.ts:98

router? ​

optional router: Options

See ​

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

Defined in ​

packages/valaxy/node/types.ts:147

unocss? ​

optional unocss: VitePluginConfig<object>

See ​

https://unocss.dev/config/

Defined in ​

packages/valaxy/node/types.ts:151

unocssPresets? ​

optional unocssPresets: object

unocss presets

attributify? ​

optional attributify: AttributifyOptions

icons? ​

optional icons: IconsOptions

typography? ​

optional typography: TypographyOptions

uno? ​

optional uno: PresetUnoOptions

See ​

https://unocss.dev/guide/presets

Defined in ​

packages/valaxy/node/types.ts:161

visualizer? ​

optional visualizer: PluginVisualizerOptions

rollup-plugin-visualizer

See ​

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

Defined in ​

packages/valaxy/node/types.ts:156

vite? ​

optional vite: UserConfig

vite.config.ts options

See ​

https://vite.dev/

Defined in ​

packages/valaxy/node/types.ts:128

vue? ​

optional vue: Options & object

@vitejs/plugin-vue options

Type declaration ​

isCustomElement? ​

optional isCustomElement: (tag) => boolean[]

See ​

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

Defined in ​

packages/valaxy/node/types.ts:133