Valaxy API Docs

Appearance

Interface: PostFrontMatter ​

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

Extends ​

Indexable ​

ts
[key: string]: any

Properties ​

ts
abbrlink: string;

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

abbrlink

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

just compatible for hexo-abbrlink

Inherited from ​

PageFrontMatter.abbrlink

albums ​

ts
albums: Album[];

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

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

Inherited from ​

PageFrontMatter.albums

aside ​

ts
aside: boolean;

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

display right sidebar

Description ​

是否显示右侧侧边栏

Inherited from ​

PageFrontMatter.aside

author ​

ts
author: string;

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

Description ​

Author @description:zh-CN 作者

Inherited from ​

PageFrontMatter.author

categories ​

ts
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? ​

ts
optional codeHeightLimit: number;

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

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

Inherited from ​

PageFrontMatter.codeHeightLimit

codepen ​

ts
codepen: boolean;

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

use codepen

Url ​

https://codepen.io/

Inherited from ​

PageFrontMatter.codepen

collections ​

ts
collections: CollectionConfig[];

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

for collections

Inherited from ​

PageFrontMatter.collections

color ​

ts
color: string;

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

title color

Deprecated ​

Please use pageTitleClass | postTitleClass instead

Inherited from ​

PageFrontMatter.color

comment ​

ts
comment: boolean;

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

display comment

Inherited from ​

PageFrontMatter.comment

ts
copyright: boolean;

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

Copyright

Description ​

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

Inherited from ​

PageFrontMatter.copyright

cover ​

ts
cover: string;

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

cover

Description ​

封面图片

Inherited from ​

PageFrontMatter.cover

date ​

ts
date: string | number | Date;

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

@description:en-US Created Date @description:zh-CN 文章创建日期

Inherited from ​

PageFrontMatter.date

draft ​

ts
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 ​

ts
encrypt: boolean;

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

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

Inherited from ​

PageFrontMatter.encrypt

encryptedContent? ​

ts
optional encryptedContent: string;

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

En ​

Description ​

encrypted content

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

Inherited from ​

PageFrontMatter.encryptedContent

encryptedPhotos? ​

ts
optional encryptedPhotos: string;

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

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

Inherited from ​

PageFrontMatter.encryptedPhotos

end ​

ts
end: boolean;

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

post is end

Description ​

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

Inherited from ​

PageFrontMatter.end

excerpt ​

ts
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 ​

ts
excerpt_type: "html" | "md" | "text" | "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? ​

ts
optional from: string | string[];

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

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

Inherited from ​

PostFrontMatter.from

ts
optional gallery_password: string;

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

@description:zh-CN 相册密码

Inherited from ​

PageFrontMatter.gallery_password

hide ​

ts
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 ​

ts
icon: string;

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

icon before title

Description ​

标题前的图标

Inherited from ​

PageFrontMatter.icon

image ​

ts
image: NodeRelations<string | ImageObject>;

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

for seo schema

Inherited from ​

PostFrontMatter.image

katex ​

ts
katex: boolean;

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

use katex

Url ​

https://katex.org/

Inherited from ​

PageFrontMatter.katex

lang ​

ts
lang: string;

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

i18n

Inherited from ​

PageFrontMatter.lang

markdownClass ​

ts
markdownClass: string;

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

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

Default ​

ts
'markdown-body'

Inherited from ​

PageFrontMatter.markdownClass

medium_zoom ​

ts
medium_zoom: boolean;

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

use medium-zoom

Url ​

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

Inherited from ​

PageFrontMatter.medium_zoom

ts
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 ​

ts
pageTitleClass: string;

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

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

Inherited from ​

PageFrontMatter.pageTitleClass

partiallyEncryptedContents? ​

ts
optional partiallyEncryptedContents: string[];

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

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

Inherited from ​

PageFrontMatter.partiallyEncryptedContents

password? ​

ts
optional password: string;

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

@description:zh-CN 加密密码

Inherited from ​

PageFrontMatter.password

password_hint? ​

ts
optional password_hint: string;

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

@description:zh-CN 密码提示

Inherited from ​

PageFrontMatter.password_hint

path ​

ts
path: string;

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

Path of post route.path

Description ​

路径

Inherited from ​

PageFrontMatter.path

photos ​

ts
photos: Photo[];

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

For layout Gallery @description:en-US Photos

Inherited from ​

PageFrontMatter.photos

postTitleClass ​

ts
postTitleClass: string;

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

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

ts
sidebar: boolean;

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

display left sidebar

Description ​

是否显示左侧侧边栏

Inherited from ​

PageFrontMatter.sidebar

ts
sponsor: boolean;

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

Display sponsor info

Description ​

是否开启赞助

Inherited from ​

PageFrontMatter.sponsor

tags ​

ts
tags: string[];

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

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

time_warning ​

ts
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 ​

ts
title: string | Record<string, string>;

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

Title

Description ​

文章标题

md
---
title: Post Title
---

i18n:

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

Inherited from ​

PageFrontMatter.title

toc ​

ts
toc: boolean;

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

display toc

Description ​

是否显示目录

Inherited from ​

PageFrontMatter.toc

top ​

ts
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 ​

ts
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 ​

ts
updated: string | number | Date;

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

Updated Time

Inherited from ​

PageFrontMatter.updated

url ​

ts
url: string;

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

En ​

override url, and jump directly

Zh ​

覆盖 post url，直接跳转