目录页面

小于 1 分钟

VuePress Theme Hope 通过 @vuepress/plugin-catalog 提供目录组件和目录页自动生成。

自动目录页生成

该功能是默认启用的，如果文件夹下没有 README.md，主题会为自动为它生成一个目录页。如需禁用，请将 plugins.catalog 设置为 false。

.vuepress/theme.ts
import { hopeTheme
 } from "vuepress-theme-hope";

export default hopeTheme
({
  plugins
: {
    catalog
: false,
  },
});

你可以在主题选项中通过 plugins.catalog 来控制它，比如:

通过 plugins.catalog.exclude 从目录生成中排除一些文件夹
通过 plugins.catalog.frontmatter 来控制 frontmatter 的生成。

.vuepress/theme.ts
import { hopeTheme
 } from "vuepress-theme-hope";

export default hopeTheme
({
  plugins
: {
    catalog
: {
      frontmatter
: (path
) => {
        if (path
.startsWith
("/zh/")) return { title
: "目录" };

        return { title
: "Catalog" };
      },
      exclude
: ["/api/", "/zh/api/"],
    },
  },
});