Skip to content

Commit 7f04265

Browse files
committed
Refactor docs
1 parent be36f14 commit 7f04265

File tree

3 files changed

+183
-158
lines changed

3 files changed

+183
-158
lines changed

lib/index.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ const emptyOptions = {}
1111
/**
1212
* Generate a table of contents (TOC).
1313
*
14+
* Looks for the first heading matching `options.heading` (case insensitive),
15+
* removes everything between it and an equal or higher next heading, and
16+
* replaces that with a list representing the rest of the document structure,
17+
* linking to all further headings.
18+
*
1419
* @param {Readonly<Options> | null | undefined} [options]
1520
* Configuration (optional).
1621
* @returns

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "remark-toc",
33
"version": "8.0.1",
4-
"description": "remark plugin to generate a Table of Contents (TOC)",
4+
"description": "remark plugin to generate a table of contents (TOC)",
55
"license": "MIT",
66
"keywords": [
77
"content",

0 commit comments

Comments
 (0)