Skip to content

Commit 182702a

Browse files
author
Jule Marcoueille
committed
Hast refactoring and new placeholder feature
1 parent d217f99 commit 182702a

16 files changed

+7335
-728
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@ The Rehype TOC plugin supports the following options:
227227
|:---------------------|:-------------------|:----------------------|:-----------------------------------------
228228
|`nav` |boolean |true |Determines whether the table of contents is wrapped in a `<nav>` element.
229229
|`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.
230+
|`placeholder` |string | |The optional placeholder string to replace with the table of contents.
230231
|`headings` |array of strings |h1, h2, h3, h4, h5, h6 |The HTML heading tags to include in the table of contents
231232
|`cssClasses.toc` |string |toc |The CSS class name for the top-level `<nav>` or `<ol>` element that contains the whole table of contents.
232233
|`cssClasses.list` |string |toc-level |The CSS class name for all `<ol>` elements in the table of contents, including the top-level one.

0 commit comments

Comments
 (0)