Skip to content

Interface: CollectionConfig

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

Properties

categories?

ts
optional categories: string[];

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


cover?

ts
optional cover: string;

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


description?

ts
optional description: string;

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


items?

ts
optional items: object[];

Defined in: packages/valaxy/client/define/collection.ts:26

items

key?

ts
optional key: string;

合集文章的唯一索引

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

title?

ts
optional title: string;

key?

ts
optional key: string;

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


name?

ts
optional name: string;

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

En

The name of the collection.

Zh

合集名称


path?

ts
optional path: string;

Defined in: packages/valaxy/client/define/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/define/collection.ts:21


title?

ts
optional title: string;

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