Skip to content

toc

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

yaml
toc:
  enable: false      # Option values: true | false
  number: false      # Option values: true | false
  expand_all: false  # Option values: true | false
  init_open: true    # Option values: true | false
  layout: right      # Option values: left | 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 一次性展开所有的目录结构

    image

  • expand_all: false 边滚动页面边展开对应的位置的目录

    image

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