New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

rehype-toc

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

rehype-toc - npm Package Compare versions

Comparing version

to
3.0.0

index.d.ts

27

CHANGELOG.md

@@ -1,8 +0,20 @@

# Change Log
Change Log
====================================================================================================
All notable changes will be documented in this file.
`rehype-toc` adheres to [Semantic Versioning](http://semver.org/).
Rehype TOC adheres to [Semantic Versioning](http://semver.org/).
## [v2.2.0](https://github.com/JS-DevTools/rehype-toc/tree/v2.2.0) (2019-07-31)
[v3.0.0](https://github.com/JS-DevTools/rehype-toc/tree/v3.0.0) (2020-02-17)
----------------------------------------------------------------------------------------------------
- Moved Rehype TOC to the [@JSDevTools scope](https://www.npmjs.com/org/jsdevtools) on NPM
- The "rehype-toc" NPM package is now just a wrapper around the scoped "@jsdevtools/rehype-toc" package
[Full Changelog](https://github.com/JS-DevTools/rehype-toc/compare/v2.1.0...v3.0.0)
[v2.2.0](https://github.com/JS-DevTools/rehype-toc/tree/v2.2.0) (2019-07-31)
----------------------------------------------------------------------------------------------------
- Added a new `customizeTOCItem` option that allows you to customize each item in the table-of-contents before it's added to the page

@@ -13,3 +25,4 @@

## [v2.1.0](https://github.com/JS-DevTools/rehype-toc/tree/v2.1.0) (2019-07-11)
[v2.1.0](https://github.com/JS-DevTools/rehype-toc/tree/v2.1.0) (2019-07-11)
----------------------------------------------------------------------------------------------------

@@ -21,3 +34,4 @@ - Added a new `position` option that allows control over where the table-of-contents is inserted into the document

## [v2.0.0](https://github.com/JS-DevTools/rehype-toc/tree/v2.0.0) (2019-07-10)
[v2.0.0](https://github.com/JS-DevTools/rehype-toc/tree/v2.0.0) (2019-07-10)
----------------------------------------------------------------------------------------------------

@@ -31,4 +45,5 @@ ### Breaking Changes

## [v1.0.0](https://github.com/JS-DevTools/rehype-toc/tree/v1.0.0) (2019-06-23)
[v1.0.0](https://github.com/JS-DevTools/rehype-toc/tree/v1.0.0) (2019-06-23)
----------------------------------------------------------------------------------------------------
Initial release 🎉
{
"name": "rehype-toc",
"version": "2.2.3",
"version": "3.0.0",
"description": "A rehype plugin that adds a table of contents (TOC) to the page",

@@ -24,47 +24,14 @@ "keywords": [

},
"main": "lib/index.js",
"types": "lib/index.d.ts",
"main": "index.js",
"types": "index.d.ts",
"files": [
"lib"
"index.js",
"index.d.ts"
],
"scripts": {
"clean": "shx rm -rf .nyc_output coverage lib",
"lint": "npm run lint:typescript && npm run lint:javascript",
"lint:typescript": "tslint -p tsconfig.json",
"lint:javascript": "eslint test",
"build": "tsc",
"watch": "tsc --watch",
"test": "mocha && npm run lint",
"coverage": "nyc node_modules/mocha/bin/mocha",
"upgrade": "npm-check -u && npm audit fix",
"bump": "bump --tag --push --all",
"release": "npm run upgrade && npm run clean && npm run build && npm test && npm run bump"
},
"engines": {
"node": ">=8"
"node": ">=10"
},
"devDependencies": {
"@types/chai": "^4.2.5",
"@types/mocha": "^5.2.7",
"@types/node": "^12.12.11",
"@types/unist": "^2.0.3",
"chai": "^4.2.0",
"coveralls": "^3.0.8",
"eslint": "^6.7.0",
"eslint-config-modular": "^7.0.1",
"mocha": "^6.2.2",
"npm-check": "^5.9.0",
"nyc": "^14.1.1",
"rehype-parse": "^6.0.2",
"rehype-slug": "^2.0.3",
"rehype-stringify": "^6.0.1",
"shx": "^0.3.2",
"tslint": "^5.20.1",
"tslint-modular": "^1.6.0",
"typescript": "^3.7.2",
"typescript-tslint-plugin": "^0.5.5",
"unified": "^8.4.2",
"version-bump-prompt": "^5.0.6"
},
"dependencies": {}
"dependencies": {
"@jsdevtools/rehype-toc": "3.0.0"
}
}

@@ -1,6 +0,6 @@

# Table of Contents plugin for rehype
# Table of Contents plugin for Rehype
A [rehype](https://github.com/rehypejs/rehype) plugin that adds a table of contents (TOC) to the page
[![Cross-Platform Compatibility](https://jstools.dev/img/badges/os-badges.svg)](https://travis-ci.com/JS-DevTools/rehype-toc)
[![Build Status](https://api.travis-ci.com/JS-DevTools/rehype-toc.svg?branch=master)](https://travis-ci.com/JS-DevTools/rehype-toc)
[![Cross-Platform Compatibility](https://jstools.dev/img/badges/os-badges.svg)](https://github.com/JS-DevTools/rehype-toc/blob/master/.github/workflows/CI-CD.yaml)
[![Build Status](https://github.com/JS-DevTools/rehype-toc/workflows/CI-CD/badge.svg)](https://github.com/JS-DevTools/rehype-toc/blob/master/.github/workflows/CI-CD.yaml)

@@ -10,4 +10,4 @@ [![Coverage Status](https://coveralls.io/repos/github/JS-DevTools/rehype-toc/badge.svg?branch=master)](https://coveralls.io/github/JS-DevTools/rehype-toc)

[![npm](https://img.shields.io/npm/v/rehype-toc.svg)](https://www.npmjs.com/package/rehype-toc)
[![License](https://img.shields.io/npm/l/rehype-toc.svg)](LICENSE)
[![npm](https://img.shields.io/npm/v/@jsdevtools/rehype-toc.svg)](https://www.npmjs.com/package/@jsdevtools/rehype-toc)
[![License](https://img.shields.io/npm/l/@jsdevtools/rehype-toc.svg)](LICENSE)

@@ -72,3 +72,3 @@

const slug = require("rehype-slug");
const toc = require("rehype-toc");
const toc = require("@jsdevtools/rehype-toc");
const stringify = require("rehype-stringify");

@@ -184,6 +184,6 @@ const fs = require("fs");

--------------------------
You can install `rehype-toc` via [npm](https://docs.npmjs.com/about-npm/).
You can install Rehype TOC via [npm](https://docs.npmjs.com/about-npm/).
```bash
npm install rehype-toc
npm install @jsdevtools/rehype-toc
```

@@ -207,3 +207,3 @@

const unified = require("unified");
const toc = require("rehype-toc");
const toc = require("@jsdevtools/rehype-toc");

@@ -266,3 +266,3 @@ // Use the Rehype TOC plugin with its default options

--------------------------
rehype-toc is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.
Rehype TOC is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.

@@ -269,0 +269,0 @@