One

主题

frontmatter 配置 ​

frontmatter 配置 ​

frontmatter 支持基于页面的配置。在每个 Markdown 文件中，可以使用 frontmatter 配置来覆盖 主题配置 中的部分选项。

首页配置 ​

features ​

Teeker 提供了 features 选项，用于在首页展示一些功能介绍，且为了不与 Vitepress 的 features 冲突，所以 Teeker 提供了 tk.features 或者 tk.banner.features 来配置首页的 features。

提示

features 获取优先级：tk.banner.features > tk.features > theme.banner.features。

yaml
---
layout: home

tk:
  features:
    - title: 指南
      description: Hd Security 使用指南说明
      link: /01.指南/
      imgUrl: /img/web.png
    - title: 设计
      description: Hd Security 设计思路说明
      link: /design/
      imgUrl: /img/ui.png
    - title: API
      description: Hd Security 所有的 API 介绍
      link: /07.API/01.API - 登录/
      imgUrl: /img/other.png
  description:
    - 故事由我书写，旅程由你见证，传奇由她聆听 —— 来自 Young Kbt
    - 积跬步以至千里，致敬每个爱学习的你 —— 来自 Evan Xu
    - 这一生波澜壮阔或是不惊都没问题 —— 来自 Weibw
---

主题配置 ​

在首页 index.md 的 frontmatter，可以覆盖 config 主题配置的如下选项：

  • banner 横幅
  • topArticle 精选文章
  • category 分类
  • tag 标签
  • friendLink 友情链接
  • docAnalysis 站点分析
  • post 文章列表
  • article 文章信息（作者、创建时间、分类、标签等）
  • page 分页

在首页 index.md 的 frontmatter 中配置时，需要以 tk 开头，然后再是主题配置的选项，举个示例：

yaml
---
tk:
  banner:
    enable: true
    bgStyle: bigImg
    imgSrc:
      - /img/bg1.jpg
      - /img/bg2.jpg
  category:
    enable: true
    limit: 7
  article:
    showIcon: false
  page:
    pageSize: 20
---

这些配置将会覆盖 config 主题配置中的对应选项。

文章页配置 ​

在文章页的 frontmatter，可以覆盖 config 主题配置的如下选项：

  • author 作者信息
  • article 文章信息（作者、创建时间、分类、标签等）
  • breadcrumb 面包屑

在文章页的 frontmatter 中配置时，直接填写 config 主题配置的对应选项，举个示例：

yaml
---
author:
  name: TianKe
  link: https://github.com/Kele-Bingtang/vitepress-theme-teek
article:
  showCategory: true
breadcrumb:
  separator: -
---

拓展配置 ​

除了支持覆盖主题配置的选项，Teeker 还提供了以下额外的选项：

yaml
---
title: 标题
date: 2025-03-07 01:16:28
permalink: /pages/b1ad26
categories:
  - 分类 1
  - 分类 2
tags:
  - 标签 1
top: true
sticky: 1
sidebar: false
article: false
comment: false
docAnalysis: false
---

title ​

  • 类型：string

页面标题，将作为一级标题显示在页面上。

date ​

  • 类型：string

页面创建时间，将作为创建时间显示在首页的文章列表、文章页顶部。

  • 类型：string

页面永久链接，将作为页面访问的 URL 路径，该配置项由 vitepress-plugin-permalink 提供。

categories ​

  • 类型：string[]

分类，将显示在首页的文章列表、分类卡片、文章页顶部，并在分类页渲染所有分类的文章。

tags ​

  • 类型：string[]

标签，将显示在首页的文章列表、标签卡片、文章页顶部，并在标签页渲染所有标签的文章。

top ​

  • 类型：boolean
  • 默认值：false

标记为精选文章。如果为 true，则在首页的精选文章卡片中显示，如果多个文章都设置了 top: true，则按照 date 进行排序（最新时间在上面）。

sticky ​

  • 类型：number

文章置顶，设置了此项将在首页文章列表中处于置顶位置，如果设置了 top: true，则在精选文章卡片的序号添加高亮背景色，背景色请看 主题配置 - 背景色。

  • 类型：boolean
  • 默认值：true

侧边栏，true 表示显示侧边栏。设置为 false 表示不显示侧边栏。

article ​

  • 类型：boolean
  • 默认值：true

非文章页的标记，非文章页如目录页、关于、友情链接等自定义页面，需要设置此项。设置之后这个页面将被认定为非文章页，不显示在首页的文章列表，不显示面包屑和文章信息（作者、时间、分类、标签等），不显示在归档页。

comment ​

  • 类型：boolean
  • 默认值：true

评论功能，true 表示显示评论区。设置为 false 表示不显示评论区。

docAnalysis ​

  • 类型：boolean
  • 默认值：true

站点分析，true 表示允许站点信息功能对 Markdown 文档进行数据分析和统计。设置为 false 表示不允许，该配置项由 vitepress-plugin-doc-analysis 提供。