Skip to content

New placeholder feature & hast refactoring #3

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

New placeholder feature & hast refactoring #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
182702a
Hast refactoring and new placeholder feature
Jan 6, 2021
de85d90
release v3.1.0
Jan 6, 2021
a7d5114
Add optional TOC inclusion feature
Jan 12, 2021
04aef46
release v3.1.1
Jan 12, 2021
6646eed
Fix TOC generation
Jan 25, 2021
6c3c24c
release v3.1.2
Jan 25, 2021
517d990
Remove optional chaining for Node<14 compatibility
Mar 30, 2021
f07bad9
release v3.1.3
Mar 30, 2021
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
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 @@ -227,6 +227,7 @@ The Rehype TOC plugin supports the following options:
|:---------------------|:-------------------|:----------------------|:-----------------------------------------
|`nav` |boolean |true |Determines whether the table of contents is wrapped in a `<nav>` element.
|`position` |string |"afterbegin" |The position at which the table of contents should be inserted, relative to the `<main>` or `<body>` element. Can be "beforebegin", "afterbegin", "beforeend", or "afterend". See [the `insertAdjacentElement()` docs](https://developer.mozilla.org/en-US/docs/Web/API/Element/insertAdjacentElement) for an explanation of each value.
|`placeholder` |string | |The optional placeholder string to replace with the table of contents.
|`headings` |array of strings |h1, h2, h3, h4, h5, h6 |The HTML heading tags to include in the table of contents
|`cssClasses.toc` |string |toc |The CSS class name for the top-level `<nav>` or `<ol>` element that contains the whole table of contents.
|`cssClasses.list` |string |toc-level |The CSS class name for all `<ol>` elements in the table of contents, including the top-level one.
Expand Down
Loading