Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(helpers/toc): max_items option >=7.3.0 #2210

Merged
merged 2 commits into from
Jul 6, 2024
Merged

docs(helpers/toc): max_items option >=7.3.0 #2210

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a608c71
docs(helpers/toc): `max_items` option `>=7.3.0`
KentarouTakeda Jul 4, 2024
b61f87e
fix: remove ja translation
KentarouTakeda Jul 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions source/docs/helpers.md
View file
Open in desktop
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