配置概述

配置概述

Teeker 内置了大量的主题配置，且不会影响 vitepress 原来的配置。

主题的配置通常添加在 .vitepress/config.ts 文件中。

如下是一份简单的模板：

import { defineConfig } from "vitepress";
import tkThemeConfig from "vitepress-theme-teek/config";

// Teeker 主题配置
const tkConfig = tkThemeConfig({
  // ...
});

// Vitepress 配置
export default defineConfig({
  extends: tkConfig,
  // ...
});

在 Vitepress 配置中通过 extends 可以将主题配置合并到 Vitepress 配置里，也就是说完全可以在主题配置里添加 Vitepress 的配置项，但是不能反过来，如：

各自配置

import { defineConfig } from "vitepress";
import tkThemeConfig from "vitepress-theme-teek/config";

// Teeker 主题配置
const tkConfig = tkThemeConfig({
  tkTheme: true,
});

// Vitepress 配置
export default defineConfig({
  extends: tkConfig,
  base: "/",
});

统一配置

import { defineConfig } from "vitepress";
import tkThemeConfig from "vitepress-theme-teek/config";

// Teeker 主题配置 + Vitepress 官方配置
const tkConfig = tkThemeConfig({
  tkTheme: true,
  base: "/",
});

export default defineConfig({
  extends: tkConfig,
});

Teeker 支持的主题配置都在 types 文件中。