Valaxy API Docs

Appearance

Interface: PageFrontMatter ​

Extends ​

  • Record<string, any>

Extended by ​

Properties ​

albums ​

albums: Album[]

@description:en-US Albums @description:zh-CN 相册

Defined in ​

packages/valaxy/types/frontmatter/page.ts:140

aside ​

aside: boolean

display right sidebar

Description ​

是否显示右侧侧边栏

Defined in ​

packages/valaxy/types/frontmatter/page.ts:85

author ​

author: string

Description ​

Author @description:zh-CN 作者

Defined in ​

packages/valaxy/types/frontmatter/page.ts:55

codeHeightLimit? ​

optional codeHeightLimit: number

@description:en-US Limit the height of the code block in px @description:zh-CN 限制代码块的高度，单位是 px

Defined in ​

packages/valaxy/types/frontmatter/page.ts:179

codepen ​

codepen: boolean

use codepen

Url ​

https://codepen.io/

Defined in ​

packages/valaxy/types/frontmatter/page.ts:129

color ​

color: string

title color

Deprecated ​

Please use pageTitleClass | postTitleClass instead

Defined in ​

packages/valaxy/types/frontmatter/page.ts:109

comment ​

comment: boolean

display comment

Defined in ​

packages/valaxy/types/frontmatter/page.ts:113

copyright: boolean

Copyright

Description ​

是否显示文章底部版权信息

Defined in ​

packages/valaxy/types/frontmatter/page.ts:66

cover ​

cover: string

cover

Description ​

封面图片

Defined in ​

packages/valaxy/types/frontmatter/page.ts:75

date ​

date: string | number | Date

Defined in ​

packages/valaxy/types/frontmatter/page.ts:41

encrypt ​

encrypt: boolean

@description:zh-CN 是否启用加密，password 存在时默认为 true

Defined in ​

packages/valaxy/types/frontmatter/page.ts:151

encryptedContent? ​

optional encryptedContent: string

En ​

Description ​

encrypted content

@description:zh-CN 加密后的内容

Defined in ​

packages/valaxy/types/frontmatter/page.ts:166

encryptedPhotos? ​

optional encryptedPhotos: string

@description:zh-CN 加密后的相册

Defined in ​

packages/valaxy/types/frontmatter/page.ts:174

end ​

end: boolean

post is end

Description ​

是否完结，将在末尾添加衬线字体 Q.E.D.

Defined in ​

packages/valaxy/types/frontmatter/page.ts:118

from? ​

optional from: string | string[]

@description:en-US Source path for client redirection @description:zh-CN 客户端重定向的源路径

Defined in ​

packages/valaxy/types/frontmatter/page.ts:184

optional gallery_password: string

@description:zh-CN 相册密码

Defined in ​

packages/valaxy/types/frontmatter/page.ts:159

icon ​

icon: string

icon before title

Description ​

标题前的图标

Defined in ​

packages/valaxy/types/frontmatter/page.ts:104

image ​

image: NodeRelations<string | ImageObject>

Defined in ​

packages/valaxy/types/frontmatter/page.ts:69

katex ​

katex: boolean

use katex

Url ​

https://katex.org/

Defined in ​

packages/valaxy/types/frontmatter/page.ts:124

lang ​

lang: string

i18n

Defined in ​

packages/valaxy/types/frontmatter/page.ts:49

markdownClass ​

markdownClass: string

@description:en-US Custom Markdown class @description:zh-CN 自定义 Markdown 样式

Default ​

ts
'markdown-body'

Defined in ​

packages/valaxy/types/frontmatter/page.ts:92

medium_zoom ​

medium_zoom: boolean

use medium-zoom

Url ​

https://github.com/francoischalifour/medium-zoom

Defined in ​

packages/valaxy/types/frontmatter/page.ts:134

pageTitleClass ​

pageTitleClass: string

@description:en-US Post title class @description:zh-CN 文章标题样式

Defined in ​

packages/valaxy/types/frontmatter/page.ts:98

partiallyEncryptedContents? ​

optional partiallyEncryptedContents: string[]

@description:zh-CN 部分加密的内容

Defined in ​

packages/valaxy/types/frontmatter/page.ts:170

password? ​

optional password: string

@description:zh-CN 加密密码

Defined in ​

packages/valaxy/types/frontmatter/page.ts:155

path ​

path: string

Path of post route.path

Description ​

路径

Defined in ​

packages/valaxy/types/frontmatter/page.ts:35

photos ​

photos: Photo[]

For layout Gallery @description:en-US Photos

Defined in ​

packages/valaxy/types/frontmatter/page.ts:146

sponsor: boolean

Display sponsor info

Description ​

是否开启赞助

Defined in ​

packages/valaxy/types/frontmatter/page.ts:61

title ​

title: string

Title

Description ​

文章标题

Defined in ​

packages/valaxy/types/frontmatter/page.ts:40

toc ​

toc: boolean

display toc

Description ​

是否显示目录

Defined in ​

packages/valaxy/types/frontmatter/page.ts:80

updated ​

updated: string | number | Date

Updated Time

Defined in ​

packages/valaxy/types/frontmatter/page.ts:45