Skip to content

Commit

Permalink
feat(helper/toc): more flexible class name (hexojs/hexo#5010) (#1886)
Browse files Browse the repository at this point in the history
  • Loading branch information
renbaoshuo authored Sep 9, 2022
1 parent 41f9f5c commit db0e92e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
8 changes: 7 additions & 1 deletion source/docs/helpers.md
Original file line number Diff line number Diff line change
Expand Up @@ -910,7 +910,13 @@ Parses all heading tags (h1~h6) in the content and inserts a table of contents.

Option | Description | Default
--- | --- | ---
`class` | Class name | toc
`class` | Class name | `toc`
`class_item` | Class name of item | `${class}-item`
`class_link` | Class name of link | `${class}-link`
`class_text` | Class name of text | `${class}-text`
`class_child` | Class name of child | `${class}-child`
`class_number` | Class name of number | `${class}-number`
`class_level` | Class name prefix of level | `${class}-level`
`list_number` | Displays list number | true
`max_depth` | Maximum heading depth of generated toc | 6
`min_depth` | Minimum heading depth of generated toc | 1
Expand Down
8 changes: 7 additions & 1 deletion source/zh-cn/docs/helpers.md
Original file line number Diff line number Diff line change
Expand Up @@ -892,7 +892,13 @@ Inserts [generator tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Elemen

参数 | 描述 | 默认值
--- | --- | ---
`class` | Class 名称 | toc
`class` | Class 名称 | `toc`
`class_item` | 目录元素的 Class 名称 | `${class}-item`
`class_link` | 目录内链接的 Class 名称 | `${class}-link`
`class_text` | 目录链接内文本的 Class 名称 | `${class}-text`
`class_child` | 目录内子列表的 Class 名称 | `${class}-child`
`class_number` | 目录序号的 Class 名称 | `${class}-number`
`class_level` | 目录层级的 Class 名称前缀 | `${class}-level`
`list_number` | 显示编号 | true
`max_depth` | 生成 TOC 的最大深度 | 6
`min_depth` | 生成 TOC 的最小深度 | 1
Expand Down

0 comments on commit db0e92e

Please sign in to comment.