J

主题

2025-03-072025-07-03配置配置
1058
4.6m
Get...

功能页配置 ​

Teek 支持构建分类页、标签页、归档页，文章清单页、登录页、风险链接提示页，这些页面本质上是一个 Markdown 文档，通过在 frontmatter 配置来开启功能，因此可以与其他文档一起放到任意目录下，并且和正常 Markdown 文档一样可以进行内容编写。

但是 Teek 建议放在 @pages 目录下，因为 Teek 不会对 @pages 目录下的文档做任何处理（自动生成侧边栏、站点分析，自动生成 frontmatter 等）。

sh
.
├─ @pages
│  ├── archivesPage.md
│  ├── articleOverviewPage.md
│  ├── categoriesPage.md
│  ├── loginPage.md
│  ├── riskLinkPage.md
│  ├── tagsPage.md

分类页 ​

在 frontmatter 中配置 categoriesPage: true 和 layout: home 来开启分类页。

yaml
---
title: 分类
permalink: /categories
categoriesPage: true
layout: home
article: false
---

permalink 需要配置为 /categories，如果你希望修改为 /c，需要在主题配置中配置 category.path 为 /c：

ts
import { defineTeekConfig } from "vitepress-theme-teek/config";

const teekConfig = defineTeekConfig({
  category: {
    path: "/c",
  },
});

标签页 ​

在 frontmatter 中配置 tagsPage: true 和 layout: home 来开启标签页。

yaml
---
title: 标签
permalink: /tags
tagsPage: true
layout: home
article: false
---

permalink 需要配置为 /tags，如果你希望修改为 /t，需要在主题配置中配置 tag.path 为 /t：

ts
import { defineTeekConfig } from "vitepress-theme-teek/config";

const teekConfig = defineTeekConfig({
  tag: {
    path: "/t",
  },
});

归档页 ​

有两种方式可以开启归档页：

  1. 在 frontmatter 配置 archivesPage: true 和 layout: page 来开启归档页
  2. 在 frontmatter 配置 layout: TkCataloguePage 来开启归档页
yaml
---
title: 归档
permalink: /archives
archivesPage: true
layout: page
article: false
sidebar: false
---
yaml
---
title: 归档
permalink: /archives
layout: TkCataloguePage
article: false
sidebar: false
---

permalink 没有强制要求为 /archives，你可以根据自己的需求进行配置，然后在导航栏配置 url 为 permalink 的值即可。

通过 frontmatter，你可以定制归档页的部分文字：归档页所有可以配置的 frontmatter 如下：

yaml
---
title: 归档
permalink: /archives
layout: TkCataloguePage
totalCount: 总共 {count} 篇文章
year: 年
month: 月
count: 篇
notFound: 未指定
---

这些文字优先级会覆盖 Teek 的国际化文字。

文章清单页 v1.2.0 ​

有两种方式可以开启文章清单页：

  1. 在 frontmatter 配置 articleOverviewPage: true 和 layout: page 来开启文章清单页
  2. 在 frontmatter 配置 layout: TkArticleOverviewPage 来开启文章清单页
yaml
---
title: 归档
permalink: /articleOverview
articleOverviewPage: true
layout: page
article: false
sidebar: false
---
yaml
---
title: 归档
permalink: /articleOverview
layout: TkArticleOverviewPage
article: false
sidebar: false
---

permalink 没有强制要求为 /articleOverview，你可以根据自己的需求进行配置，然后在导航栏配置 url 为 permalink 的值即可。

您可以通过 publishDateFormat 来设置发布时间的格式，比如 yyyy-MM-dd，默认为 yyyy-MM-dd hh:mm:ss。

yaml
---
title: 文章清单
permalink: /articleOverview
articleOverviewPage: true
layout: page
publishDateFormat: yyyy-MM-dd
article: false
sidebar: false
---

登录页 v1.3.0 ​

有两种方式可以开启登录页：

  1. 在 frontmatter 配置 loginPage: true 和 layout: false 来开启登录页，此时登录页不含有导航
  2. 在 frontmatter 配置 layout: TkLoginPage 来开启登录页，此时登录页顶部有导航
yaml
---
permalink: /login
layout: false
loginPage: true
logo: /teek-logo-large.png
name: VitePress Theme Teek
leftImg: /login/bg-1.png
article: false
---
yaml
---
permalink: /login
layout: TkLoginPage
logo: /teek-logo-large.png
name: VitePress Theme Teek
leftImg: /login/bg-1.png
article: false
---

leftImg: /login/bg-1.png v1.3.4 是添加左侧图片的配置项，如果添加该配置，左侧将会出现图片，右侧为登录框；如果不添加该配置，则登录框位于屏幕中间。

风险链接提示页 v1.3.0 ​

有两种方式可以开启风险链接提示页：

  1. 在 frontmatter 配置 riskLinkPage: true 和 layout: false 来开启登录页，此时风险链接提示页不含有导航
  2. 在 frontmatter 配置 layout: TkRiskLinkPage 来开启登录页，此时风险链接提示页顶部有导航
yaml
---
permalink: /risk-link
layout: false
riskLinkPage: true
logo: /teek-logo-large.png
name: VitePress Theme Teek # 与 desc 二选一
desc: 即将离开 VitePress Theme Teek，请注意财产安全 # 与 name 二选一
linkIllegal: 链接安全性校验中，请稍后 ...
article: false
---
yaml
---
permalink: /risk-link
layout: TkRiskLinkPage
logo: /teek-logo-large.png
name: VitePress Theme Teek # 与 desc 二选一
desc: 即将离开 VitePress Theme Teek，请注意财产安全 # 与 name 二选一
linkIllegal: 链接安全性校验中，请稍后 ...
article: false
---
最近更新