@@ -80,7 +80,13 @@ Generate a Table of Contents.
8080 for links and images too)
8181* Removes all following contents until an equal or higher heading is found
8282* Inserts a list representation of the hierarchy of following headings
83- * Adds links to following headings, using the same slugs as GitHub
83+ * Links from the table of contents to following headings, using the same slugs
84+ as GitHub
85+
86+ > ** Note** : if you’re later compiling to HTML, you still need to add anchors to
87+ > headings.
88+ > Previously that was done by this plugin as well, but now you must
89+ > [ ` .use(slug) ` to include ` remark-slug ` ] [ slug ] explicitly.
8490
8591##### ` options `
8692
@@ -101,14 +107,16 @@ are included (those with three hashes, `###`).
101107
102108## Related
103109
110+ * [ ` remark-slug ` ] [ slug ]
111+ – Add anchors to headings using GitHub’s algorithm
104112* [ ` remark-collapse ` ] ( https://github.com/Rokt33r/remark-collapse )
105113 – Make a section collapsible
106- * [ ` remark-normalize-headings ` ] ( https://github.com/eush77 /remark-normalize-headings )
114+ * [ ` remark-normalize-headings ` ] ( https://github.com/remarkjs /remark-normalize-headings )
107115 — Make sure there is no more than a single top-level heading in the document
108116 and rewrite the rest accordingly
109117* [ ` remark-behead ` ] ( https://github.com/mrzmmr/remark-behead )
110118 — Change header levels
111- * [ ` mdast-util-toc ` ] ( https://github.com/barrythepenguin /mdast-util-toc )
119+ * [ ` mdast-util-toc ` ] ( https://github.com/syntax-tree /mdast-util-toc )
112120 — Core functionality of this plugin
113121
114122## Contribute
@@ -168,3 +176,5 @@ abide by its terms.
168176[ author ] : https://wooorm.com
169177
170178[ remark ] : https://github.com/remarkjs/remark
179+
180+ [ slug ] : https://github.com/remarkjs/remark-slug
0 commit comments