Interface: PageFrontMatter ​

Source: 1.1.0 · e3417e89b638

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

Extends ​

Extended by ​

Indexable ​

ts
[key: string]: any

Properties ​

ts
abbrlink: string;

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

abbrlink

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

just compatible for hexo-abbrlink

albums ​

ts
albums: Album[];

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

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

aside ​

ts
aside: boolean;

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

display right sidebar

Description ​

是否显示右侧侧边栏

author ​

ts
author: string;

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

Description ​

Author @description:zh-CN 作者

canonical? ​

ts
optional canonical?: string;

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

Canonical URL or site-relative path, independent of the current route alias.

Inherited from ​

BaseFrontMatter.canonical

codeHeightLimit? ​

ts
optional codeHeightLimit?: number;

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

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

codepen ​

ts
codepen: boolean;

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

use codepen

Url ​

https://codepen.io/

collections ​

ts
collections: CollectionConfig[];

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

for collections

comment ​

ts
comment: boolean;

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

display comment

ts
copyright: boolean;

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

Copyright

Description ​

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

cover? ​

ts
optional cover?: string;

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

cover

Description ​

封面图片（使用组件封面时可省略）

coverComponent? ​

ts
optional coverComponent?: string;

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

@description:en-US Vue component name from components/covers/, rendered by supporting themes. An image cover is optional. @description:zh-CN components/covers/ 下的 Vue 组件名，由支持的主题渲染。图片 cover 可省略。

coverProps? ​

ts
optional coverProps?: Record<string, unknown>;

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

JSON-serializable props passed to the cover component.

date ​

ts
date: string | number | Date;

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

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

Inherited from ​

PageFrontMatter.date

encrypt ​

ts
encrypt: boolean;

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

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

encryptedContent? ​

ts
optional encryptedContent?: string;

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

En ​

Description ​

encrypted content

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

encryptedPhotos? ​

ts
optional encryptedPhotos?: string;

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

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

end ​

ts
end: boolean;

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

post is end

Description ​

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

from? ​

ts
optional from?: string | string[];

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

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

ts
optional gallery_password?: string;

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

@description:zh-CN 相册密码

icon ​

ts
icon: string;

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

icon before title

Description ​

标题前的图标

image ​

ts
image: NodeRelations<string | ImageSimple>;

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

for seo schema

katex ​

ts
katex: boolean;

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

Enable/disable KaTeX math rendering for this page. Overrides the global features.katex setting.

  • When features.katex: true (default), set katex: false to disable KaTeX for this page.
  • When features.katex: false, set katex: true to enable KaTeX for this page.

Url ​

https://katex.org/

lang ​

ts
lang: string;

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

i18n

markdownClass ​

ts
markdownClass: string;

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

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

Default ​

ts
'markdown-body'

medium_zoom ​

ts
medium_zoom: boolean;

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

use medium-zoom

Url ​

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

ogImage ​

ts
ogImage: string;

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

@description:en-US Open Graph image for SEO @description:zh-CN Open Graph 图片，用于 SEO

pageTitleClass ​

ts
pageTitleClass: string;

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

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

partiallyEncryptedContents? ​

ts
optional partiallyEncryptedContents?: string[];

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

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

password? ​

ts
optional password?: string;

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

@description:zh-CN 加密密码

password_hint? ​

ts
optional password_hint?: string;

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

@description:zh-CN 密码提示

path ​

ts
path: string;

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

Path of post route.path

Description ​

路径

photos ​

ts
photos: Photo[];

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

For layout Gallery @description:en-US Photos

ts
sidebar: boolean;

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

display left sidebar

Description ​

是否显示左侧侧边栏

ts
sponsor: boolean;

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

Display sponsor info

Description ​

是否开启赞助

title ​

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

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

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:137

display toc

Description ​

是否显示目录

updated ​

ts
updated: string | number | Date;

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

Updated Time

Inherited from ​

PageFrontMatter.updated