Skip to content

Commit

Permalink
docs(helpers/toc): max_items option >=7.3.0 (#2210)
Browse files Browse the repository at this point in the history
  • Loading branch information
KentarouTakeda authored Jul 6, 2024
1 parent a2ab214 commit e937de2
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions source/docs/helpers.md
Original file line number Diff line number Diff line change
Expand Up @@ -945,18 +945,19 @@ Parses all heading tags (h1~h6) in the content and inserts a table of contents.
<%- toc(str, [options]) %>
```

| Option | Description | Default |
| ----------------------- | -------------------------------------- | ----------------- |
| `class` | Class name | `toc` |
| `class_item` (+6.3.0) | Class name of item | `${class}-item` |
| `class_link` (+6.3.0) | Class name of link | `${class}-link` |
| `class_text` (+6.3.0) | Class name of text | `${class}-text` |
| `class_child` (+6.3.0) | Class name of child | `${class}-child` |
| `class_number` (+6.3.0) | Class name of number | `${class}-number` |
| `class_level` (+6.3.0) | 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 |
| Option | Description | Default |
| ----------------------- | ---------------------------------------- | ----------------- |
| `class` | Class name | `toc` |
| `class_item` (+6.3.0) | Class name of item | `${class}-item` |
| `class_link` (+6.3.0) | Class name of link | `${class}-link` |
| `class_text` (+6.3.0) | Class name of text | `${class}-text` |
| `class_child` (+6.3.0) | Class name of child | `${class}-child` |
| `class_number` (+6.3.0) | Class name of number | `${class}-number` |
| `class_level` (+6.3.0) | 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 |
| `max_items` (+7.3.0) | Maximum number of items in generated toc | `Infinity` |

**Examples:**

Expand Down

0 comments on commit e937de2

Please sign in to comment.