博客文章
约 305 字大约 1 分钟
2024-03-03
概述
适用于 博客类型的文章。
示例:
---
title: 文章标题
tags:
- tag1
- tag2
---
配置
sticky
- 类型:
boolean | number
- 默认值:
false
是否在文章列表中,置顶当前文章。
如果为 number
,则数字越大,文章置顶的位置越靠前。
article
- 类型:
boolean
- 默认值:
true
是否在文章列表中显示当前文章。
draft
- 类型:
boolean
- 默认值:
false
标记文章是否为草稿。被标记为草稿的文章,仅在 开发环境时显示在文章列表中,生产环境不会显示。
tags
- 类型:
string[]
- 默认值:
[]
文章标签。
cover
- 类型:
string
- 默认值:
''
文章封面图。 封面图仅显示在 文章列表页。
仅支持 绝对路径 以及 远程图片地址。
coverStyle
- 类型:
BlogPostCoverStyle
- 默认值: `null
封面图配置。
interface BlogPostCoverStyle {
/**
* 博客文章封面图的位置
*/
layout?: 'left' | 'right' | 'odd-left' | 'odd-right' | 'top'
/**
* 博客文章封面图的比例
*
* @default '4:3'
*/
ratio?: number | `${number}:${number}`
/**
* 封面图的宽度, 仅在 layout 为 'left' 或 'right' 时生效
*
* @default 240
*/
width?: number
/**
* 是否使用紧凑模式,紧凑模式下,封面图紧贴容器边缘
* @default false
*/
compact?: boolean
}
贡献者
更新日志
2025/8/4 06:59
查看所有更新日志
e113f
-feat(theme): improve post draft status (#662)于0fd6c
-refactor(theme): improve types and flat config (#524)于4227b
-feat(theme): split the postcover
field intocover
andcoverStyle
(#512)于1d723
-docs: update blog and notes docs (#199)于30715
-docs: update docs于2fb3d
-docs: update theme docs于c56ba
-feat: 全新的文档!于