Skip to content

Commit eee7092

Browse files
Moved the NPM package to the @jsdevtools scope
1 parent cccdb63 commit eee7092

File tree

3 files changed

+30
-15
lines changed

3 files changed

+30
-15
lines changed

CHANGELOG.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,37 @@
1-
# Change Log
1+
Change Log
2+
====================================================================================================
23
All notable changes will be documented in this file.
3-
`rehype-toc` adheres to [Semantic Versioning](http://semver.org/).
4+
Rehype TOC adheres to [Semantic Versioning](http://semver.org/).
45

56

6-
## [v2.2.0](https://github.com/JS-DevTools/rehype-toc/tree/v2.2.0) (2019-07-31)
7+
[v3.0.0](https://github.com/JS-DevTools/rehype-toc/tree/v3.0.0) (2020-02-17)
8+
----------------------------------------------------------------------------------------------------
9+
10+
- Moved Rehype TOC to the [@JSDevTools scope](https://www.npmjs.com/org/jsdevtools) on NPM
11+
12+
- The "rehype-toc" NPM package is now just a wrapper around the scoped "@jsdevtools/rehype-toc" package
13+
14+
[Full Changelog](https://github.com/JS-DevTools/rehype-toc/compare/v2.1.0...v3.0.0)
15+
16+
17+
[v2.2.0](https://github.com/JS-DevTools/rehype-toc/tree/v2.2.0) (2019-07-31)
18+
----------------------------------------------------------------------------------------------------
719

820
- Added a new `customizeTOCItem` option that allows you to customize each item in the table-of-contents before it's added to the page
921

1022
[Full Changelog](https://github.com/JS-DevTools/rehype-toc/compare/v2.1.0...v2.2.0)
1123

1224

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

1528
- Added a new `position` option that allows control over where the table-of-contents is inserted into the document
1629

1730
[Full Changelog](https://github.com/JS-DevTools/rehype-toc/compare/v2.0.0...v2.1.0)
1831

1932

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

2236
### Breaking Changes
2337

@@ -26,6 +40,7 @@ All notable changes will be documented in this file.
2640
[Full Changelog](https://github.com/JS-DevTools/rehype-toc/compare/v1.0.1...v2.0.0)
2741

2842

29-
## [v1.0.0](https://github.com/JS-DevTools/rehype-toc/tree/v1.0.0) (2019-06-23)
43+
[v1.0.0](https://github.com/JS-DevTools/rehype-toc/tree/v1.0.0) (2019-06-23)
44+
----------------------------------------------------------------------------------------------------
3045

3146
Initial release 🎉

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Table of Contents plugin for rehype
1+
# Table of Contents plugin for Rehype
22
A [rehype](https://github.com/rehypejs/rehype) plugin that adds a table of contents (TOC) to the page
33

44
[![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)
@@ -7,8 +7,8 @@ A [rehype](https://github.com/rehypejs/rehype) plugin that adds a table of conte
77
[![Coverage Status](https://coveralls.io/repos/github/JS-DevTools/rehype-toc/badge.svg?branch=master)](https://coveralls.io/github/JS-DevTools/rehype-toc)
88
[![Dependencies](https://david-dm.org/JS-DevTools/rehype-toc.svg)](https://david-dm.org/JS-DevTools/rehype-toc)
99

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

1313

1414

@@ -68,7 +68,7 @@ This script reads the `input.html` file above writes the results to `output.html
6868
const unified = require("unified");
6969
const parse = require("rehype-parse");
7070
const slug = require("rehype-slug");
71-
const toc = require("rehype-toc");
71+
const toc = require("@jsdevtools/rehype-toc");
7272
const stringify = require("rehype-stringify");
7373
const fs = require("fs");
7474

@@ -179,10 +179,10 @@ Here's the HTML that gets created by the above script. Notice that a table of co
179179

180180
Installation
181181
--------------------------
182-
You can install `rehype-toc` via [npm](https://docs.npmjs.com/about-npm/).
182+
You can install Rehype TOC via [npm](https://docs.npmjs.com/about-npm/).
183183

184184
```bash
185-
npm install rehype-toc
185+
npm install @jsdevtools/rehype-toc
186186
```
187187

188188
You'll probably want to install [unified](https://unifiedjs.com/), [rehype-parse](https://github.com/rehypejs/rehype/tree/master/packages/rehype-parse), [rehype-stringify](https://github.com/rehypejs/rehype/tree/master/packages/rehype-stringify), and [rehype-slug](https://github.com/rehypejs/rehype-slug) as well.
@@ -201,7 +201,7 @@ The Rehype TOC plugin works just like any other Rehype plugin. Pass it to [the `
201201

202202
```javascript
203203
const unified = require("unified");
204-
const toc = require("rehype-toc");
204+
const toc = require("@jsdevtools/rehype-toc");
205205

206206
// Use the Rehype TOC plugin with its default options
207207
unified().use(toc);
@@ -259,7 +259,7 @@ To build the project locally on your computer:
259259

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

264264

265265

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "rehype-toc",
2+
"name": "@jsdevtools/rehype-toc",
33
"version": "2.2.3",
44
"description": "A rehype plugin that adds a table of contents (TOC) to the page",
55
"keywords": [

0 commit comments

Comments
 (0)