Valaxy API Docs

Appearance

Interface: PageFrontMatter ​

Defined in: packages/valaxy/types/frontmatter/page.ts:29

Extends ​

  • Record<string, any>

Extended by ​

Indexable ​

[key: string]: any

Properties ​

abbrlink: string

Defined in: packages/valaxy/types/frontmatter/page.ts:43

abbrlink

generated by valaxy-addon-abbrlink, do not manually modify

just compatible for hexo-abbrlink

albums ​

albums: Album[]

Defined in: packages/valaxy/types/frontmatter/page.ts:162

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

aside ​

aside: boolean

Defined in: packages/valaxy/types/frontmatter/page.ts:107

display right sidebar

Description ​

是否显示右侧侧边栏

author ​

author: string

Defined in: packages/valaxy/types/frontmatter/page.ts:77

Description ​

Author @description:zh-CN 作者

codeHeightLimit? ​

optional codeHeightLimit: number

Defined in: packages/valaxy/types/frontmatter/page.ts:205

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

codepen ​

codepen: boolean

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

use codepen

Url ​

https://codepen.io/

color ​

color: string

Defined in: packages/valaxy/types/frontmatter/page.ts:131

title color

Deprecated ​

Please use pageTitleClass | postTitleClass instead

comment ​

comment: boolean

Defined in: packages/valaxy/types/frontmatter/page.ts:135

display comment

copyright: boolean

Defined in: packages/valaxy/types/frontmatter/page.ts:88

Copyright

Description ​

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

cover ​

cover: string

Defined in: packages/valaxy/types/frontmatter/page.ts:97

cover

Description ​

封面图片

date ​

date: string | number | Date

Defined in: packages/valaxy/types/frontmatter/page.ts:63

encrypt ​

encrypt: boolean

Defined in: packages/valaxy/types/frontmatter/page.ts:173

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

encryptedContent? ​

optional encryptedContent: string

Defined in: packages/valaxy/types/frontmatter/page.ts:192

En ​

Description ​

encrypted content

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

encryptedPhotos? ​

optional encryptedPhotos: string

Defined in: packages/valaxy/types/frontmatter/page.ts:200

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

end ​

end: boolean

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

post is end

Description ​

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

from? ​

optional from: string | string[]

Defined in: packages/valaxy/types/frontmatter/page.ts:210

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

optional gallery_password: string

Defined in: packages/valaxy/types/frontmatter/page.ts:185

@description:zh-CN 相册密码

icon ​

icon: string

Defined in: packages/valaxy/types/frontmatter/page.ts:126

icon before title

Description ​

标题前的图标

image ​

image: NodeRelations<string | ImageObject>

Defined in: packages/valaxy/types/frontmatter/page.ts:91

katex ​

katex: boolean

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

use katex

Url ​

https://katex.org/

lang ​

lang: string

Defined in: packages/valaxy/types/frontmatter/page.ts:71

i18n

markdownClass ​

markdownClass: string

Defined in: packages/valaxy/types/frontmatter/page.ts:114

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

Default ​

ts
'markdown-body'

medium_zoom ​

medium_zoom: boolean

Defined in: packages/valaxy/types/frontmatter/page.ts:156

use medium-zoom

Url ​

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

pageTitleClass ​

pageTitleClass: string

Defined in: packages/valaxy/types/frontmatter/page.ts:120

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

partiallyEncryptedContents? ​

optional partiallyEncryptedContents: string[]

Defined in: packages/valaxy/types/frontmatter/page.ts:196

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

password? ​

optional password: string

Defined in: packages/valaxy/types/frontmatter/page.ts:177

@description:zh-CN 加密密码

password_hint? ​

optional password_hint: string

Defined in: packages/valaxy/types/frontmatter/page.ts:181

@description:zh-CN 密码提示

path ​

path: string

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

Path of post route.path

Description ​

路径

photos ​

photos: Photo[]

Defined in: packages/valaxy/types/frontmatter/page.ts:168

For layout Gallery @description:en-US Photos

sponsor: boolean

Defined in: packages/valaxy/types/frontmatter/page.ts:83

Display sponsor info

Description ​

是否开启赞助

title ​

title: string | Record<string, string>

Defined in: packages/valaxy/types/frontmatter/page.ts:62

Title

Description ​

文章标题

md
---
title: Post Title
---
md
---
title:
  en: Post Title
  zh-CN: 文章标题
---

toc ​

toc: boolean

Defined in: packages/valaxy/types/frontmatter/page.ts:102

display toc

Description ​

是否显示目录

updated ​

updated: string | number | Date

Defined in: packages/valaxy/types/frontmatter/page.ts:67

Updated Time