Skip to content

配置简介

Teek 内置了大量的主题配置,但是不会影响 vitepress 原来的配置,两者是独立生效的。

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

如下是一份简单的模板:

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

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

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

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

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

// Teek 主题配置
const teekConfig = defineTeekConfig({
  tkTheme: true,
});

// Vitepress 配置
export default defineConfig({
  extends: teekConfig,
  themeConfig: {
    logo: "/teek-logo-mini.svg",
  },
});
ts
// .vitepress/config.ts
import { defineConfig } from "vitepress";
import defineTeekConfig from "vitepress-theme-teek/config";

// Teek 主题配置 + Vitepress 官方配置
const teekConfig = defineTeekConfig({
  tkTheme: true,
  logo: "/teek-logo-mini.svg",
});

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

Teek 支持的主题配置都在 Types 文件中。