remark-flexible-toc 1.2.0 → 1.2.2

package/README.md

@@ -12,11 +12,11 @@ This package is a [**unified**][unified] ([**remark**][remark]) plugin **to expo
 
 [**unified**][unified] is a project that transforms content with abstract syntax trees (ASTs) using the new parser [**micromark**][micromark]. [**remark**][remark] adds support for markdown to unified. [**mdast**][mdast] is the Markdown Abstract Syntax Tree (AST) which is a specification for representing markdown in a syntax tree.
 
-**This plugin is a remark plugin that doesn't transform the mdast but gets info from the mdast.**
+**This plugin is a remark plugin that doesn't transform the MDAST but gets info from the MDAST.**
 
 ## When should I use this?
 
-This plugin `remark-flexible-toc` is useful if you want to get the table of contents (TOC) from the markdown/MDX document. The `remark-flexible-toc` exposes the table of contents (TOC) in two ways:
+**`remark-flexible-toc`** is useful if you want to get the table of contents (TOC) from the markdown/MDX document. It exposes the table of contents (TOC) in two ways:
 + by adding the `toc` into the `Vfile.data`
 + by mutating a reference array if provided in the options
 
@@ -48,6 +48,34 @@ Say we have the following file, `example.md`, which consists some headings.
 ### Subheading 2
 ```
 
+#### the first way of getting TOC via file.data
+
+And our module, `example.js`, looks as follows:
+
+```javascript
+import { read } from "to-vfile";
+import remark from "remark";
+import gfm from "remark-gfm";
+import remarkRehype from "remark-rehype";
+import rehypeStringify from "rehype-stringify";
+import remarkFlexibleToc from "remark-flexible-toc";
+
+main();
+
+async function main() {
+  const file = await remark()
+    .use(gfm)
+    .use(remarkFlexibleToc)
+    .use(remarkRehype)
+    .use(rehypeStringify)
+    .process(await read("example.md"));
+
+  console.log(file.data.toc);
+}
+```
+
+#### the second way of getting TOC via a reference array in the options
+
 And our module, `example.js`, looks as follows:
 
 ```javascript
@@ -70,15 +98,11 @@ async function main() {
     .use(rehypeStringify)
     .process(await read("example.md"));
 
-  // the first way of getting TOC via file.data
-  console.log(file.data.toc);
-
-  // the second way of getting TOC, since we provided a reference array in the options
   console.log(toc);
 }
 ```
 
-Now, running `node example.js` you see that the same table of contents is logged in the console:
+Now, running both `node example.js` you will see that the same table of contents (TOC) is logged in the console:
 
 ```javascript
 [
@@ -106,7 +130,7 @@ Now, running `node example.js` you see that the same table of contents is logged
 ]
 ```
 
-Without `remark-flexible-toc`, there wouldn't be any `toc` key in the `file.data`:
+Without **`remark-flexible-toc`**, there wouldn't be any `toc` key in the `file.data`:
 
 ## Options
 
@@ -150,7 +174,7 @@ Now, the TOC is accessable via `vfile.data.headings`.
 
 #### `tocRef`
 
-It is an **array of reference** option for getting the table of contents (TOC), which is the second way of getting the TOC from the `remark-flexible-toc`.
+It is an **array of reference** option for getting the table of contents (TOC), which is the second way of getting the TOC from **`remark-flexible-toc`**.
 
 The reference array should be an empty array, if not, it is emptied by the plugin.
 
@@ -262,9 +286,9 @@ type TocItem = {
 ```
 
 > [!NOTE]
-> If there is a remark plugin before the `remark-flexible-toc` in the plugin chain, which provides custom id for headings like `remark-heading-id`, that custom id takes precedence for `href`.
+> If there is a remark plugin before **`remark-flexible-toc`** in the plugin chain, which provides custom id for headings like **`remark-heading-id`**, that custom id takes precedence for `href`.
 
-The `remark-flexible-toc` uses the `github-slugger` internally for producing unique links. Then, it is possible you to use [**rehype-slug**][rehype-slug] (forIDs on headings) and [**rehype-autolink-headings**][rehype-autolink-headings] (for anchors that link-to-self) because they use the same `github-slugger`.
+**`remark-flexible-toc`** uses the **`github-slugger`** internally for producing unique links. Then, it is possible you to use [**rehype-slug**][rehype-slug] (forIDs on headings) and [**rehype-autolink-headings**][rehype-autolink-headings] (for anchors that link-to-self) because they use the same **`github-slugger`**.
 
 As an example for the unique heading links (notice the same heading texts).
 
@@ -317,7 +341,7 @@ The `github-slugger` produces unique links with using a counter mechanism intern
 
 ## Numbering for Ordered Table of Contents (TOC)
 
-The `remark-flexible-toc` produces always the `numbering` for TOC items in case you show the ordered TOC.
+**`remark-flexible-toc`** produces always the `numbering` for TOC items in case you show the ordered TOC.
 
 The **numbering** of a TOC item is an array of number. The numbers in the `numbering` corresponds the **level of the headers**. With that structure, you know which header is under which header.
 
@@ -360,7 +384,7 @@ This plugin works with `unified` version 6+ and `remark` version 7+. It is compa
 
 ## Security
 
-Use of `remark-flexible-toc` does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.
+Use of **`remark-flexible-toc`** does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.
 
 ## My Plugins
 

package/dist/esm/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../src/index.ts"],"version":"5.8.3"}
+{"root":["../../src/index.ts"],"version":"5.9.2"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-flexible-toc",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Remark plugin to expose the table of contents via Vfile.data or via an option reference",
   "type": "module",
   "exports": "./dist/esm/index.js",
@@ -48,29 +48,29 @@
     "url": "https://github.com/ipikuka/remark-flexible-toc/issues"
   },
   "devDependencies": {
-    "@eslint/js": "^9.28.0",
-    "@types/node": "^22.15.29",
+    "@eslint/js": "^9.35.0",
+    "@types/node": "^24.3.1",
     "@types/remark-heading-id": "^1.0.0",
-    "@vitest/coverage-v8": "^3.2.1",
-    "@vitest/eslint-plugin": "^1.2.1",
-    "dedent": "^1.6.0",
-    "eslint": "^9.28.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-plugin-prettier": "^5.4.1",
-    "globals": "^16.2.0",
-    "prettier": "^3.5.3",
+    "@vitest/coverage-v8": "^3.2.4",
+    "@vitest/eslint-plugin": "^1.3.9",
+    "dedent": "^1.7.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "globals": "^16.3.0",
+    "prettier": "^3.6.2",
     "rehype-format": "^5.0.1",
     "rehype-stringify": "^10.0.1",
     "remark-gfm": "^4.0.1",
     "remark-heading-id": "^1.0.1",
     "remark-parse": "^11.0.0",
     "remark-rehype": "^11.1.2",
-    "rimraf": "^5.0.10",
+    "rimraf": "^6.0.1",
     "type-coverage": "^2.29.7",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.33.1",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.43.0",
     "unified": "^11.0.5",
-    "vitest": "^3.2.1"
+    "vitest": "^3.2.4"
   },
   "dependencies": {
     "@types/mdast": "^4.0.4",