常见问题

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

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

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

正确用法

// .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);
    },
  },
});

错误用法

// .vitepress/config.mts
import { defineConfig } from "vitepress";
import myMdPlugin from "my-md-plugin";

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

侧边栏问题

侧边栏新增图标

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

侧边栏支持折叠

进行如下配置：

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