Skip to content

Interface: ValaxyHooks

Defined in: packages/valaxy/node/types/hook.ts:23

Properties

build:after

ts
build:after: () => HookResult;

Defined in: packages/valaxy/node/types/hook.ts:42

Returns

HookResult


build:before

ts
build:before: () => HookResult;

Defined in: packages/valaxy/node/types/hook.ts:41

Returns

HookResult


config:init

ts
config:init: () => HookResult;

Defined in: packages/valaxy/node/types/hook.ts:25

Returns

HookResult


content:before-load

ts
content:before-load: () => HookResult;

Defined in: packages/valaxy/node/types/hook.ts:55

Experimental

Called before content loaders start fetching.

Returns

HookResult

See

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


content:loaded

ts
content:loaded: () => HookResult;

Defined in: packages/valaxy/node/types/hook.ts:61

Experimental

Called after all content loaders have finished and files are written to cache.

Returns

HookResult

See

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


md:afterRender

ts
md:afterRender: (ctx) => HookResult;

Defined in: packages/valaxy/node/types/hook.ts:39

Called after a markdown page has been loaded and its frontmatter/excerpt resolved. Fires for all .md routes (posts, pages, collections, etc.). Provides access to the route, raw markdown content, resolved excerpt, frontmatter data, and file path. Useful for addons that need to inspect or extend page metadata (e.g., auto-generating excerpts).

Parameters

ctx

MdAfterRenderContext

Returns

HookResult

See

valaxy/node/plugins/vueRouter.ts extendRoute


options:resolved

ts
options:resolved: () => HookResult;

Defined in: packages/valaxy/node/types/hook.ts:24

Returns

HookResult


statistics

ts
statistics: (ctx) => HookResult;

Defined in: packages/valaxy/node/types/hook.ts:48

Called to compute statistics (word count, reading time) for a markdown route. Default implementation uses presetStatistics; addons/themes can hook to override.

Parameters

ctx
options

{ enable: boolean; readTime: { speed: { cn: number; en: number; }; }; }

options.enable

boolean

options.readTime

{ speed: { cn: number; en: number; }; }

options.readTime.speed

{ cn: number; en: number; }

options.readTime.speed.cn

number

Chinese word count speed

Description

中文每分钟阅读字数

Default

ts
300 (300/分钟)
options.readTime.speed.en

number

English word count speed

Description

英文每分钟阅读字数

Default

ts
100 (200/分钟)
route

EditableTreeNode

Returns

HookResult


vue-router:beforeWriteFiles

ts
vue-router:beforeWriteFiles: (root) => HookResult;

Defined in: packages/valaxy/node/types/hook.ts:30

Parameters

root

EditableTreeNode

Returns

HookResult


vue-router:extendRoute

ts
vue-router:extendRoute: (route) => HookResult;

Defined in: packages/valaxy/node/types/hook.ts:29

Parameters

route

EditableTreeNode

Returns

HookResult

See

valaxy/node/plugins/vueRouter.ts extendRoute