Valaxy API Docs

Appearance

Interface: PostFrontMatter ​

Defined in: packages/valaxy/types/frontmatter/post.ts:5

Extends ​

Indexable ​

[key: string]: any

Properties ​

albums ​

albums: Album[]

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

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

Inherited from ​

PageFrontMatter.albums

aside ​

aside: boolean

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

display right sidebar

Description ​

是否显示右侧侧边栏

Inherited from ​

PageFrontMatter.aside

author ​

author: string

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

Description ​

Author @description:zh-CN 作者

Inherited from ​

PageFrontMatter.author

categories ​

categories: string | string[]

Defined in: packages/valaxy/types/frontmatter/post.ts:41

@description:en-US Category, if it is an array, it represents multiple folders in order @description:zh-CN 分类，若为数组，则按顺序代表多层文件夹

codeHeightLimit? ​

optional codeHeightLimit: number

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

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

Inherited from ​

PageFrontMatter.codeHeightLimit

codepen ​

codepen: boolean

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

use codepen

Url ​

https://codepen.io/

Inherited from ​

PageFrontMatter.codepen

color ​

color: string

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

title color

Deprecated ​

Please use pageTitleClass | postTitleClass instead

Inherited from ​

PageFrontMatter.color

comment ​

comment: boolean

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

display comment

Inherited from ​

PageFrontMatter.comment

copyright: boolean

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

Copyright

Description ​

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

Inherited from ​

PageFrontMatter.copyright

cover ​

cover: string

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

cover

Description ​

封面图片

Inherited from ​

PageFrontMatter.cover

date ​

date: string | number | Date

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

Inherited from ​

PageFrontMatter.date

draft ​

draft: boolean

Defined in: packages/valaxy/types/frontmatter/post.ts:64

@description:en-US Whether it is a draft, it will only be displayed during development @description:zh-CN 是否为草稿，将仅在开发时被展示

encrypt ​

encrypt: boolean

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

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

Inherited from ​

PageFrontMatter.encrypt

encryptedContent? ​

optional encryptedContent: string

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

En ​

Description ​

encrypted content

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

Inherited from ​

PageFrontMatter.encryptedContent

encryptedPhotos? ​

optional encryptedPhotos: string

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

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

Inherited from ​

PageFrontMatter.encryptedPhotos

end ​

end: boolean

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

post is end

Description ​

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

Inherited from ​

PageFrontMatter.end

excerpt ​

excerpt: string

Defined in: packages/valaxy/types/frontmatter/post.ts:26

@description:en-US custom excerpt, excerpt_type will be invalid

Description ​

手动指定摘要，此时 excerpt_type 将会无效

excerpt_type ​

excerpt_type: "html" | "text" | "md" | "ai"

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

Description ​

摘要类型

Default ​

ts
'html'
render type of excerpt
- md: render as raw markdown
- html: render as html
- text: render as text

from? ​

optional from: string | string[]

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

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

Inherited from ​

PageFrontMatter.from

optional gallery_password: string

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

@description:zh-CN 相册密码

Inherited from ​

PageFrontMatter.gallery_password

hide ​

hide: boolean | "index"

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

hide in index

  • true/all: hide in index & archive
  • index: hide in index

Description ​

是否隐藏

icon ​

icon: string

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

icon before title

Description ​

标题前的图标

Inherited from ​

PageFrontMatter.icon

image ​

image: NodeRelations<string | ImageObject>

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

Inherited from ​

PageFrontMatter.image

katex ​

katex: boolean

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

use katex

Url ​

https://katex.org/

Inherited from ​

PageFrontMatter.katex

lang ​

lang: string

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

i18n

Inherited from ​

PageFrontMatter.lang

markdownClass ​

markdownClass: string

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

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

Default ​

ts
'markdown-body'

Inherited from ​

PageFrontMatter.markdownClass

medium_zoom ​

medium_zoom: boolean

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

use medium-zoom

Url ​

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

Inherited from ​

PageFrontMatter.medium_zoom

nav: boolean

Defined in: packages/valaxy/types/frontmatter/post.ts:52

@description:en-US Whether to display the previous and next navigation @description:zh-CN 是否显示前一篇、后一篇导航

pageTitleClass ​

pageTitleClass: string

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

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

Inherited from ​

PageFrontMatter.pageTitleClass

partiallyEncryptedContents? ​

optional partiallyEncryptedContents: string[]

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

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

Inherited from ​

PageFrontMatter.partiallyEncryptedContents

password? ​

optional password: string

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

@description:zh-CN 加密密码

Inherited from ​

PageFrontMatter.password

path ​

path: string

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

Path of post route.path

Description ​

路径

Inherited from ​

PageFrontMatter.path

photos ​

photos: Photo[]

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

For layout Gallery @description:en-US Photos

Inherited from ​

PageFrontMatter.photos

postTitleClass ​

postTitleClass: string

Defined in: packages/valaxy/types/frontmatter/post.ts:10

@description:en-US Custom post title class in post list @description:zh-CN 文章列表中 自定义标题样式

sponsor: boolean

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

Display sponsor info

Description ​

是否开启赞助

Inherited from ​

PageFrontMatter.sponsor

tags ​

tags: string[]

Defined in: packages/valaxy/types/frontmatter/post.ts:46

@description:en-US Tags, can have multiple @description:zh-CN 标签，可以有多个

time_warning ​

time_warning: number | boolean

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

En ​

when the post is updated more than 30 days ago, show a warning default 30 days, you can set time_warning in frontmatter to change it

Zh ​

当文章更新时间超过 30 天时，显示一个警告 默认 30 天，你可以在 frontmatter 中设置 time_warning （数字）来修改，单位 ms

Example ​

ts
3600000

title ​

title: string

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

Title

Description ​

文章标题

Inherited from ​

PageFrontMatter.title

toc ​

toc: boolean

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

display toc

Description ​

是否显示目录

Inherited from ​

PageFrontMatter.toc

top ​

top: number

Defined in: packages/valaxy/types/frontmatter/post.ts:58

@description:en-US Pin to top, the larger the number, the closer to the front @description:zh-CN 置顶，数字越大越靠前

type ​

type: string

Defined in: packages/valaxy/types/frontmatter/post.ts:16

@description:en-US Post Card Type, can be bilibili/yuque/... (need theme support) @description:zh-CN 卡片类型，可以是 bilibili/yuque/... (需主题支持)

updated ​

updated: string | number | Date

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

Updated Time

Inherited from ​

PageFrontMatter.updated

url ​

url: string

Defined in: packages/valaxy/types/frontmatter/post.ts:21

En ​

override url, and jump directly

Zh ​

覆盖 post url，直接跳转