Interface: PostFrontMatter
Extends
Properties
albums
albums:
Album
[]
@description:en-US Albums @description:zh-CN 相册
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:146
aplayer
aplayer:
boolean
use aplayer
Url
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:125
aside
aside:
boolean
display right sidebar
Description
是否显示右侧侧边栏
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:85
author
author:
string
Description
Author @description:zh-CN 作者
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:55
categories
categories:
string
|string
[]
@description:en-US Category, if it is an array, it represents multiple folders in order @description:zh-CN 分类,若为数组,则按顺序代表多层文件夹
Defined in
packages/valaxy/types/frontmatter/post.ts:41
codeHeightLimit?
optional
codeHeightLimit:number
@description:en-US Limit the height of the code block in px @description:zh-CN 限制代码块的高度,单位是 px
Inherited from
PageFrontMatter
.codeHeightLimit
Defined in
packages/valaxy/types/frontmatter/page.ts:185
codepen
codepen:
boolean
use codepen
Url
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:135
color
color:
string
title color
Deprecated
Please use pageTitleClass
| postTitleClass
instead
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:109
comment
comment:
boolean
display comment
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:113
copyright
copyright:
boolean
Copyright
Description
是否显示文章底部版权信息
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:66
cover
cover:
string
cover
Description
封面图片
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:75
date
date:
string
|number
|Date
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:41
draft
draft:
boolean
@description:en-US Whether it is a draft, it will only be displayed during development @description:zh-CN 是否为草稿,将仅在开发时被展示
Defined in
packages/valaxy/types/frontmatter/post.ts:64
encrypt
encrypt:
boolean
@description:zh-CN 是否启用加密,password 存在时默认为 true
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:157
encryptedContent?
optional
encryptedContent:string
En
Description
encrypted content
@description:zh-CN 加密后的内容
Inherited from
PageFrontMatter
.encryptedContent
Defined in
packages/valaxy/types/frontmatter/page.ts:172
encryptedPhotos?
optional
encryptedPhotos:string
@description:zh-CN 加密后的相册
Inherited from
PageFrontMatter
.encryptedPhotos
Defined in
packages/valaxy/types/frontmatter/page.ts:180
end
end:
boolean
post is end
Description
是否完结,将在末尾添加衬线字体 Q.E.D.
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:118
excerpt
excerpt:
string
@description:en-US custom excerpt, excerpt_type
will be invalid
Description
手动指定摘要,此时 excerpt_type
将会无效
Defined in
packages/valaxy/types/frontmatter/post.ts:26
excerpt_type
excerpt_type:
"html"
|"text"
|"md"
|"ai"
Description
摘要类型
Default
'html'
render type of excerpt
- md: render as raw markdown
- html: render as html
- text: render as text
Defined in
packages/valaxy/types/frontmatter/post.ts:35
from?
optional
from:string
|string
[]
@description:en-US Source path for client redirection @description:zh-CN 客户端重定向的源路径
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:190
gallery_password?
optional
gallery_password:string
@description:zh-CN 相册密码
Inherited from
PageFrontMatter
.gallery_password
Defined in
packages/valaxy/types/frontmatter/page.ts:165
hide
hide:
boolean
|"index"
hide in index
- true/
all
: hide in index & archive index
: hide in index
Description
是否隐藏
Defined in
packages/valaxy/types/frontmatter/post.ts:71
icon
icon:
string
icon before title
Description
标题前的图标
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:104
image
image:
NodeRelations
<string
|ImageObject
>
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:69
katex
katex:
boolean
use katex
Url
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:130
lang
lang:
string
i18n
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:49
markdownClass
markdownClass:
string
@description:en-US Custom Markdown class @description:zh-CN 自定义 Markdown 样式
Default
'markdown-body'
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:92
medium_zoom
medium_zoom:
boolean
use medium-zoom
Url
https://github.com/francoischalifour/medium-zoom
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:140
nav
nav:
boolean
@description:en-US Whether to display the previous and next navigation @description:zh-CN 是否显示前一篇、后一篇导航
Defined in
packages/valaxy/types/frontmatter/post.ts:52
pageTitleClass
pageTitleClass:
string
@description:en-US Post title class @description:zh-CN 文章标题样式
Inherited from
PageFrontMatter
.pageTitleClass
Defined in
packages/valaxy/types/frontmatter/page.ts:98
partiallyEncryptedContents?
optional
partiallyEncryptedContents:string
[]
@description:zh-CN 部分加密的内容
Inherited from
PageFrontMatter
.partiallyEncryptedContents
Defined in
packages/valaxy/types/frontmatter/page.ts:176
password?
optional
password:string
@description:zh-CN 加密密码
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:161
path
path:
string
Path of post route.path
Description
路径
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:35
photos
photos:
Photo
[]
For layout Gallery @description:en-US Photos
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:152
postTitleClass
postTitleClass:
string
@description:en-US Custom post title class in post list @description:zh-CN 文章列表中 自定义标题样式
Defined in
packages/valaxy/types/frontmatter/post.ts:10
sponsor
sponsor:
boolean
Display sponsor info
Description
是否开启赞助
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:61
tags
tags:
string
[]
@description:en-US Tags, can have multiple @description:zh-CN 标签,可以有多个
Defined in
packages/valaxy/types/frontmatter/post.ts:46
time_warning
time_warning:
number
|boolean
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
3600000
Defined in
packages/valaxy/types/frontmatter/post.ts:83
title
title:
string
Title
Description
文章标题
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:40
toc
toc:
boolean
display toc
Description
是否显示目录
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:80
top
top:
number
@description:en-US Pin to top, the larger the number, the closer to the front @description:zh-CN 置顶,数字越大越靠前
Defined in
packages/valaxy/types/frontmatter/post.ts:58
type
type:
string
@description:en-US Post Card Type, can be bilibili/yuque/... (need theme support) @description:zh-CN 卡片类型,可以是 bilibili/yuque/... (需主题支持)
Defined in
packages/valaxy/types/frontmatter/post.ts:16
updated
updated:
string
|number
|Date
Updated Time
Inherited from
Defined in
packages/valaxy/types/frontmatter/page.ts:45
url
url:
string
En
override url, and jump directly
Zh
覆盖 post url,直接跳转