Interface: ValaxyHooks ​

Source: 1.1.0 · e3417e89b638

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

Properties ​

build:after ​

ts
build:after: () => HookResult;

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

Returns ​

HookResult


build:before ​

ts
build:before: () => HookResult;

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

Returns ​

HookResult


config:init ​

ts
config:init: () => HookResult;

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

Returns ​

HookResult


content:before-load ​

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

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

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

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

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, file path, and the configured Markdown renderer. 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:29

Returns ​

HookResult


statistics ​

ts
statistics: (ctx) => HookResult;

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

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

Parameters ​

root ​

EditableTreeNode

Returns ​

HookResult


vue-router:extendRoute ​

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

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

Parameters ​

route ​

EditableTreeNode

Returns ​

HookResult

See ​

valaxy/node/plugins/vueRouter.ts extendRoute