Skip to content
本页目录

toc

toc 用于设置文章 TOC 目录结构,非常实用的功能,可以快速查看文章整体的目录和跳转指定位置,建议开启。

yaml
toc:
  enable: false
  number: false
  expand_all: false
  init_open: false
  layout: right

enable

enable 是否开启 TOC,可选值:truefalse

  • enable: false

    image

  • enable: true

    image

number

number 给 TOC 目录结构自动加上数字编号,可选值:truefalse

  • number: false

    image

  • number: true

    image

expand_all

expand_all 展开所有目录结构,可选值:truefalse

  • expand_all: true 自动展开所有的目录结构
  • expand_all: false 边滚动页面边展开对应的位置的目录

init_open

init_open 打开文章页时是否自动打开 TOC 目录结构,可选值:truefalse

layout v3.7.0

layout 用于设置 TOC 目录结构模块的布局位置,默认为 right (右侧),可选值:leftright

  • layout: right

    image

  • layout: left

    image

Released under the AGPL-3.0 License