Valaxy API Docs

Appearance

Interface: ValaxyExtendConfig ​

Properties ​

addons? ​

optional addons: ValaxyAddons

Defined in ​

packages/valaxy/node/types.ts:164

build ​

build: object

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

Don't fail builds due to dead links.

Default ​
ts
false

ssgForPagination ​

ssgForPagination: boolean

Enable SSG for pagination

Default ​

false When enabled, it will generate pagination pages for you. /page/1, /page/2, ...

Defined in ​

packages/valaxy/node/types.ts:61

components? ​

optional components: Options

Defined in ​

packages/valaxy/node/types.ts:129

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

devtools? ​

optional devtools: boolean

Experimental

Enable Vue Devtools & Valaxy Devtools

See ​

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

Defined in ​

packages/valaxy/node/types.ts:152

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

Defined in ​

packages/valaxy/node/types.ts:157

features ​

features: object

Markdown Feature

katex ​

katex: boolean

enable katex for global

Defined in ​

packages/valaxy/node/types.ts:113

hooks? ​

optional hooks: Partial<ValaxyHooks>

Defined in ​

packages/valaxy/node/types.ts:166

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>

Defined in ​

packages/valaxy/node/types.ts:130

markdown? ​

optional markdown: MarkdownOptions & Options

for markdown

Defined in ​

packages/valaxy/node/types.ts:156

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

router? ​

optional router: Options

Defined in ​

packages/valaxy/node/types.ts:131

unocss? ​

optional unocss: VitePluginConfig<object>

Defined in ​

packages/valaxy/node/types.ts:132

unocssPresets? ​

optional unocssPresets: object

unocss presets

attributify? ​

optional attributify: AttributifyOptions

icons? ​

optional icons: IconsOptions

typography? ​

optional typography: TypographyOptions

uno? ​

optional uno: PresetUnoOptions

Defined in ​

packages/valaxy/node/types.ts:141

visualizer? ​

optional visualizer: PluginVisualizerOptions

rollup-plugin-visualizer

See ​

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

Defined in ​

packages/valaxy/node/types.ts:137

vite? ​

optional vite: UserConfig

Defined in ​

packages/valaxy/node/types.ts:120

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