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

Jump to bottom

Extract ToC #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Extract ToC #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ The Rehype TOC plugin supports the following options:
|`cssClasses.link` |string |toc-link |The CSS class name for all `<a>` elements in the table of contents.
|`customizeTOC` |function(toc) | |Allows you to customize the table of contents before it is added to the page.<br><br>The function receives the TOC node tree and can modify it in any way you want. Or you can return a new node tree to use instead. Or return `false` to prevent the the TOC from being added to the page.
|`customizeTOCItem` |function(toc, heading)| |Allows you to customize each item in the table of contents before it is added to the page.<br><br>The function receives the TOC item's node tree and the heading node that it refers to. You can modify the nodes in any way you want. Or you can return a new node tree to use instead. Or return `false` to prevent the the TOC from being added to the page.
|`extract` |boolean |false |Determines whether the table of contents is extracted from the HTML of the page. When true, only the table of contents node is returned.<br><br>If `customizeTOC` or `customizeTOCItem` return falsy values, then an empty `div` node will be returned instead.



Expand Down