白羽拾光 🕊️

主题

廖浩龙2026-05-17 20:00:00
1166
4.6m
0

Frontmatter 配置模板 原创 ​

本文中的所有配置示例均为非默认值。使用时根据以下约定配置即可。

  • 布尔类型：按需保留
  • 字符串类型：根据实际情况修改

文章页配置 ​

文档风格 - 快速开始 ​

yaml
title: Frontmatter 配置模板
date: 2026-05-01 00:00:00
permalink: /blog/frontmatter-template
categories:
  - 建站二三事
tags:
  - yaml
  - 模板
titleTag: 原创
top: true
sticky: 1
description: 描述...
coverImg: /articles/...

outline: deep

博客风格 - 快速开始 ​

yaml
title: Frontmatter 配置模板
date: 2026-05-01 00:00:00
permalink: /blog/frontmatter-template
categories:
  - 建站二三事
tags:
  - yaml
  - 模板
titleTag: 原创
top: true
sticky: 1
sidebar: false
description: 描述...
coverColor: #DDDDDD
coverImg: /articles/...

aside: false
pageClass: article-banner-light-text

完整模板 ​

yaml
##### Frontmatter 配置 - 文章配置
##### https://vp.teek.top/reference/frontmatter.html

# 页面标题
title: 
# 创建日期
date: 2026-01-01 00:00:00
# 永久化链接
permalink: /folder/fileName
# 分类。个人建议：一篇文章只设一个分类，建议使用文件夹名
categories:
  - 
# 标签。个人建议：一篇文章可以使用多个标签
tags:
  - 
# 标题前的标签
titleTag: 原创
# 标记为精选文章
top: true
# 文章置顶，同时设置置顶顺序。如果同时设置了 top: true，则在精选文章卡片的序号上添加高亮背景色
sticky: 1
# 是否显示侧边栏。为 true 时，不会显示 articleBanner 封面图
sidebar: false
# 是否显示在首页的文章列表和归档页。为 false 时，不会显示 articleBanner 封面图
article: false
# 是否显示评论区
comment: false
# 文档摘要，显示在主页卡片中
description: 欢迎来到白羽拾光！这里是我的部落格！
# articleBanner 文章封面背景色，优先级低于 coverImg，在全局默认封面图（articleBanner.defaultCoverImg）已配置时，此配置同样不会生效
coverColor: #DDDDDD
# articleBanner 文章封面图，文件名需要写后缀名
coverImg: /articles/...
# 是否收录到分类统计目录中。
# vitepress-plugin-catalogue 插件提供
inCatalogue: false
# 站点分析，true 表示允许站点信息功能对 Markdown 文档进行数据分析和统计。
# vitepress-plugin-doc-analysis 插件提供
docAnalysis: false
# 如果 Markdown 未设置一级标题，访问时是否自动添加一级标题。一级标题获取优先级：frontmatter.title > 文件名
# vitepress-plugin-md-h1 插件提供
autoTitle: false
# 是否在文章底部显示最近更新栏
articleUpdate: false
# 是否在首页的文章列表中显示
inHomePost: false
# 侧边栏排序，值越小越靠前，设置此项将覆盖文件名序号进行排序
# vitepress-plugin-sidebar-resolve 插件提供
sidebarSort: 1
# 侧边栏标题前缀，可以添加 HTML 如 iconfont 图标
# vitepress-plugin-sidebar-resolve 插件提供
sidebarPrefix: "" # 侧边栏前缀
# 侧边栏标题后缀，可以添加 HTML 如 iconfont 图标
# vitepress-plugin-sidebar-resolve 插件提供
sidebarSuffix: "" # 侧边栏后缀

##### 覆盖 teekConfig 中的全局设置
# 作者
author:
  name: 
  link: 
# 关闭 articleTopTip，设为 true 或 false 都可覆盖 teekConfig 设置，从而禁用 Tip
articleTopTip: false
# 关闭 articleBottomTip，设为 true 或 false 都可覆盖 teekConfig 设置，从而禁用 Tip
articleBottomTip: false
# 关闭侧边栏的「分享此页面」的配置
articleShare: false
# 文章页的样式风格，default 为 VitePress 原生风格，card 为单卡片风格，segment 为片段卡片风格，card-nav 和 segment-nav 会额外修改导航栏样式
pageStyle: default

##### vitepress 配置
##### https://vitepress.dev/zh/reference/frontmatter-config

# 指定页面的布局（doc | home | page）
layout: doc
# 是否显示导航栏
navbar: true
# 是否使用大纲栏
aside: false
# 大纲展示策略：none（不展示）、deep (多级)
outline: deep
# 是否在当前页面的页脚中显示最后更新时间的文本。如果指定了日期时间，则会显示该日期时间而不是上次 git 修改的时间戳
lastUpdated: false
# 是否在当前页的页脚显示编辑链接
editLink: false
# 是否显示页脚
# 由于我未在 config.mts - themeConfig.footer 中配置页脚，所以此选项无效
footer: false
# 添加自定义 class
pageClass: article-banner-light-text

##### 自定义配置

# 替换默认的半年后过时置顶消息
topTip:
  type: ""
  title: ""
  text: ""

目录页配置 ​

快速开始 ​

yaml
title: 建站二三事 # 改
date: 2026-05-01 00:00:00 # 改
permalink: /blog # 改
catalogue: true
layout: page
path: blog # 改
desc: 白羽拾光 🕊 建站笔记 # 改
pageTitle: 目录
sidebar: false
article: false

完整模板 ​

yaml
title: 建站二三事 # 目录页标题
date: 2026-05-01 00:00:00 # 时间
permalink: /blog # 永久链接
catalogue: true # 目录页（必填）
layout: page # page 布局（必填）
path: blog # 设置为根目录下的某个文件夹相对路径（必填）
desc: 白羽拾光 🕊 建站笔记 # 目录描述
pageTitle: 目录 # 页面标题，默认为目录
sidebar: false # 不显示侧边栏
article: false # 不显示在首页的文章列表和归档页
最近更新