VitePress Theme Teek

🪁 VitePress Theme Teek

Teek 是一个轻量、简洁高效、灵活配置，易于扩展的 VitePress 主题.

相比于原版 VitePress 主题 Teek新增特性如下:

• 知识管理

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

结构化 & 体系化

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

• 碎片化 & 个性化

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

• 文档风 & 博客风

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

💎 拓展功能

🎨 使用方法

使用详情可参考 Teek 爱好者写的 手把手操作文档

Teek 在线安装

pnpm install vitepress-theme-teek -D

Teek 引入

根据 VitePress 的要求，需要在 .vitepress/theme/index.ts 文件中引入 Teek 主题。如果没有该路径，需要先创建它：

// .vitepress/theme/index.ts
import Teek from "vitepress-theme-teek";
import "vitepress-theme-teek/index.css";

export default {
  extends: Teek,
};

然后在 .vitepress/config.mts 文件中引入 Teek 的配置加载器：

// .vitepress/config.mts
import { defineConfig } from "vitepress";
import { defineTeekConfig } from "vitepress-theme-teek/config";

// Teek 主题配置
const teekConfig = defineTeekConfig({});

// VitePress 配置
export default defineConfig({
  extends: teekConfig,
  // ...
});

有关 Teek 更多的配置信息，请从 配置简介 开始阅读。

⛳ 版本更新

pnpm add vitepress-theme-teek@latest -D