Skip to content

目录导航配置说明

约 297 字小于 1 分钟

2025-11-20

目录导航配置位于 src/config.ts 文件中的 toc 对象,控制博客文章内的目录导航显示设置。

toc: {
		enable: true, // 启用目录功能
		depth: 2, // 目录深度,1-6,1 表示只显示 h1 标题,2 表示显示 h1 和 h2 标题,依此类推
		useJapaneseBadge: true, // 使用日语p假名标记(あいうえお...)代替数字,开启后会将 1、2、3... 改为 ァ、ィ、ゥ...
	},
  • enable:是否启用目录导航功能,设置为 true 则在文章侧边显示目录导航
  • depth:目录导航显示的标题深度,取值范围为 1 到 6
    • 1 表示只显示一级标题(<h1>
    • 2 表示显示一级和二级标题(<h1><h2>
    • 依此类推,直到显示所有六级标题(<h1><h6>
  • useJapaneseBadge:是否使用日语假名标记代替数字,设置为 true 则会将目录导航中的数字替换为对应的日语假名(ァ、ィ、ゥ...)
  • 例如:
    • 数字标记:1、2、3...
    • 日语假名标记:ァ、ィ、ゥ、ェ、ォ...

开启这个配置在首页也有作用,会变成文章列表导航!