Valaxy API Docs

Appearance

Interface: CollectionConfig ​

Defined in: packages/valaxy/client/types/collection.ts:1

Properties ​

categories? ​

ts
optional categories?: string[];

Defined in: packages/valaxy/client/types/collection.ts:20

collapse? ​

ts
optional collapse?: boolean;

Defined in: packages/valaxy/client/types/collection.ts:34

En ​

Whether to show collection as a single collapsed entry in homepage/archive lists. When true (default), a synthetic collection card is added to the post list, representing all articles in the collection as one entry. When false, no synthetic entry is added.

Zh ​

是否在首页/归档列表中以单个条目展示合集。 为 true（默认）时，合集以一张卡片出现在文章列表中， 代表合集内的所有文章。 为 false 时，不添加合集条目。

Default ​

ts
true

cover? ​

ts
optional cover?: string;

Defined in: packages/valaxy/client/types/collection.ts:18

description? ​

ts
optional description?: string;

Defined in: packages/valaxy/client/types/collection.ts:19

items? ​

ts
optional items?: object[];

Defined in: packages/valaxy/client/types/collection.ts:39

items

key? ​

ts
optional key?: string;

合集文章的唯一索引

对应路径为 /collections/${key}/${item.key}

ts
optional link?: string;
En ​

Link to an existing page or external URL. Internal links (starting with /) use <RouterLink>. External links (e.g. https://...) open in a new tab. Mutually exclusive with key — if both are set, link takes precedence.

Zh ​

链接到已有页面或外部 URL。 内部链接（以 / 开头）使用 <RouterLink>。 外部链接（如 https://...）在新标签页中打开。 与 key 互斥——若同时设置，link 优先。

title? ​

ts
optional title?: string;

key? ​

ts
optional key?: string;

Defined in: packages/valaxy/client/types/collection.ts:3

name? ​

ts
optional name?: string;

Defined in: packages/valaxy/client/types/collection.ts:17

En ​

The name of the collection.

Zh ​

合集名称

path? ​

ts
optional path?: string;

Defined in: packages/valaxy/client/types/collection.ts:9

if key is not provided, path is required

if key is provided, path = /collections/${key}

tags? ​

ts
optional tags?: string[];

Defined in: packages/valaxy/client/types/collection.ts:21

title? ​

ts
optional title?: string;

Defined in: packages/valaxy/client/types/collection.ts:2