@mehm8128/rehype-toc 1.0.0 → 1.1.1

package/README.md

@@ -1,21 +1,41 @@
 # rehype-toc
 
-## Development
+[![CI on main](https://github.com/mehm8128/rehype-toc/actions/workflows/main.yml/badge.svg)](https://github.com/mehm8128/rehype-toc/actions/workflows/main.yml)
+[![NPM Version](https://img.shields.io/npm/v/@mehm8128/rehype-toc)](https://www.npmjs.com/package/@mehm8128/rehype-toc)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-- Install dependencies:
+rehype plugin to generate a table of contents from headings in your markdown.
+
+You can create the table of contents as follows.
+
+![A table of contents whose each items are anchor link.](assets/toc.png)
+
+## Installation
 
 ```bash
-pnpm install
+pnpm install @mehm8128/rehype-toc
 ```
 
-- Run the unit tests:
+## Usage
 
-```bash
-pnpm run test
+### astro.config.mjs
+
+```ts
+import { rehypeCollapsibleToc } from "@mehm8128/rehype-toc";
+
+export default defineConfig({
+  markdown: {
+    rehypePlugins: [rehypeCollapsibleToc],
+  },
+});
 ```
 
-- Build the library:
+### rehype
 
-```bash
-pnpm run build
+```ts
+import { rehype } from "rehype"
+import { rehypeCollapsibleToc } from "@mehm8128/rehype-toc";
+
+const input = "<h2 id="heading-id"><a href="#heading-id">Heading</a></h2>";
+const { value } = await rehype().use(rehypeCollapsibleToc).process(input);
 ```

package/dist/index.d.ts

@@ -1,7 +1,6 @@
-import { Element, Root } from "hast";
+import { Root } from "hast";
 
 //#region src/index.d.ts
-declare const rehypeCollapsableToc: () => (tree: Root) => void;
-declare const visitorCallback: (node: Element, rootUlElement: Element) => void;
+declare const rehypeCollapsibleToc: () => (tree: Root) => void;
 //#endregion
-export { rehypeCollapsableToc, visitorCallback };
+export { rehypeCollapsibleToc };

package/dist/index.js

@@ -1,7 +1,7 @@
 import { visit } from "unist-util-visit";
 
 //#region src/index.ts
-const rehypeCollapsableToc = () => {
+const rehypeCollapsibleToc = () => {
 	return (tree) => {
 		const rootUlElement = {
 			type: "element",
@@ -12,7 +12,7 @@ const rehypeCollapsableToc = () => {
 		visit(tree, "element", (node) => {
 			visitorCallback(node, rootUlElement);
 		});
-		const detailsElement = createCollapsableToc(rootUlElement);
+		const detailsElement = createCollapsibleToc(rootUlElement);
 		tree.children.unshift(detailsElement);
 	};
 };
@@ -44,8 +44,8 @@ const searchSameLevelUlElement = (rootUlElement, level) => {
 	const headingTextElement = assertElementText(headingAnchorElement.children[0]);
 	const rootElementHeadingLevel = getHeadingLevelFromText(headingTextElement);
 	if (rootElementHeadingLevel === level) return rootLiElement;
-	if (rootLiElement.children[1] === void 0) return;
-	const childUlElement = assertElementNode(rootLiElement.children[1]);
+	const childUlElement = assertElementNodeList(rootLiElement.children)[1];
+	if (childUlElement === void 0) return;
 	return searchSameLevelUlElement(assertElementNodeList(childUlElement.children), level);
 };
 /**
@@ -53,8 +53,8 @@ const searchSameLevelUlElement = (rootUlElement, level) => {
 */
 const getDeepestLiElement = (rootUlElement) => {
 	const rootLiElement = assertElementNode(rootUlElement[rootUlElement.length - 1]);
-	if (!rootLiElement.children[1]) return rootLiElement;
-	const olElement = assertElementNode(rootLiElement.children[1]);
+	const olElement = assertElementNodeList(rootLiElement.children)[1];
+	if (!olElement) return rootLiElement;
 	return getDeepestLiElement(assertElementNodeList(olElement.children));
 };
 const getHeadingLevelFromElement = (headingElement) => {
@@ -94,7 +94,7 @@ const createListItemElement = (node) => {
 		children: [anchorElement]
 	};
 };
-const createCollapsableToc = (rootUlElement) => {
+const createCollapsibleToc = (rootUlElement) => {
 	const summaryElement = {
 		type: "element",
 		tagName: "summary",
@@ -126,4 +126,4 @@ const assertElementText = (node) => {
 };
 
 //#endregion
-export { rehypeCollapsableToc, visitorCallback };
+export { rehypeCollapsibleToc };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@mehm8128/rehype-toc",
-	"version": "1.0.0",
+	"version": "1.1.1",
 	"type": "module",
 	"repository": {
 		"type": "git",
@@ -8,7 +8,7 @@
 	},
 	"homepage": "https://github.com/mehm8128/rehype-toc",
 	"license": "MIT",
-	"description": "rehype plugin to generate a collapsable table of contents",
+	"description": "rehype plugin to generate a collapsible table of contents",
 	"keywords": [
 		"rehype",
 		"toc",