Vitepress Theme Teek

主题

Teeker2025-04-05
257
1.1m

常见问题 ​

安装第三方 Markdown 插件后，Teek 内置插件失效 ​

请不要使用 VitePress 提供的 markdown.config 函数来加载 Markdown-it 插件，因为 VitePress 方式会覆盖主题内置的 Markdown-it 插件。

请在 teekConfig 中使用 markdown.plugins 函数来加载 Markdown-it 插件。

ts
// .vitepress/config.mts
import { defineTeekConfig } from "vitepress-theme-teek/config";
import myMdPlugin from "my-md-plugin";

const teekConfig = defineTeekConfig({
  markdown: {
    config: md => {
      md.use(myMdPlugin);
    },
  },
});
ts
// .vitepress/config.mts
import { defineConfig } from "vitepress";
import myMdPlugin from "my-md-plugin";

export default defineConfig({
  markdown: {
    config: md => {
      md.use(myMdPlugin);
    },
  },
});

举个例子，要想引入 vitepress-plugin-legend 插件来显示 mermaid 代码块，就需要在 teekConfig 中加载，而不是在 defineConfig 中加载。

侧边栏问题 ​

侧边栏新增图标 ​

请参阅文档 侧边栏新增图标。

侧边栏支持折叠 ​

进行如下配置：

ts
const teekConfig = defineTeekConfig({
  vitePlugins: {
    sidebarOption: {
      collapsed: true, // 开启侧边栏折叠功能。true 默认折叠，false 默认不折叠
    },
  },
});