简介

Teek 是一个轻量、简洁高效、灵活配置、易于扩展的 VitePress 主题 ✨，是在默认主题的基础上进行拓展，支持 VitePress 的所有功能、配置，完全可以零成本迁移过来。

使用 Teek 可以很方便的搭建一个结构化的知识库或博客。

警告

• Node.js 18.0.0及以上版本
• 在使用 Teek 前，要求至少会 VitePress 的基本使用和默认主题的基本配置，然后再查看本文档
• 本文档仅负责介绍 Teek 对 VitePress 默认主题的扩展部分，更多配置请移步 VitePress 中文文档

特性

知识管理

包含三种典型的知识管理形态：结构化、碎片化、体系化。轻松打造属于你自己的知识管理平台。

结构化 &体系化

自动生成侧边栏、目录页、索引页、面包屑等，轻松构建一个结构化知识库。

碎片化 &个性化

博客功能提供快速构建知识的碎片化形态，并提供大量个性化的主题配置。

文档风 &博客风

支持通过配置随意切换文档风和博客风，支持个人博客、文档站、知识库等场景。

拓展功能

相较于 VitePress 主题，Teek 主要实现了博客风格的功能，这些功能也兼容文档风格，您现在正在阅读的是 Teek 的文档风格。

全局

• 侧边栏自动生成，根据目录自动生成侧边栏，无需手动配置
• 提供目录页，根据 Markdown文件路径自动生成目录
• 自动生成 frontmatter，并且支持拓展 frontmatter格式
• 自动生成一级标题
• 全站背景图片
• Markdown拓展：居中、居右容器、卡片容器、Demo容器、TODO列表、Video容器
• 主题多元化：4 种布局模式、8 种主题风格选择，且支持自定义扩展新的主题风格
• 移动端适配：自动适配移动端
• ...

首页

• Banner功能：提供 3 种风格选择：局部背景色、局部图片、全屏图片，提供打印个性签名、切换个性签名选择，提供 Feature功能
• 文章列表：支持切换列表和卡片模式，展示文章标题、封面图、作者、创建时间、更新时间、标签、分类，且支持重写文章列表
• 博客卡片栏：博主信息栏、精选文章栏、分类栏、标签栏、友情链接栏、站点信息栏
• 全屏壁纸模式：只保留 Banner背景图片或全站背景图片，且禁止滚动、打开开发者工具、右键功能
• 页脚：展示社交图标、版权信息、备案信息、自定义信息
• ...

文章页

• 文章信息：展示面包屑、作者、创建时间、更新时间、标签、分类、字数、阅读时长
• 评论区：提供 Giscus、Twikoo、Waline、Artalk四种评论提供商选择，并且支持自定义评论区
• 代码块：UI 升级，支持一键折叠/展开
• 文章页风格书页化：提供 3 种风格选择：VitePress 原生、整体卡片化、片段卡片化
• 文章打赏：支持 3 种打赏风格选择
• 文章分享：提供一键复制文章链接功能
• 最近更新栏：展示最近更新文章
• ...

功能页

• 分类页
• 标签页
• 归档页
• 清单页
• 登录页
• 风险链接提示页

除了上述功能，Teek 也提供了各种 CSS文件来增强 VitePress 的样式，并提供大量的插槽支持二次开发。

如果您是其他主题的用户，也可以按需引入 Teek 的功能，增强自己的站点风格。