UNPKG

@jsdevtools/rehype-toc

Version:

A rehype plugin that adds a table of contents (TOC) to the page

47 lines (25 loc) 2.15 kB
Change Log ==================================================================================================== All notable changes will be documented in this file. Rehype TOC adheres to [Semantic Versioning](http://semver.org/). [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 [Full Changelog](https://github.com/JS-DevTools/rehype-toc/compare/v2.1.0...v2.2.0) [v2.1.0](https://github.com/JS-DevTools/rehype-toc/tree/v2.1.0) (2019-07-11) ---------------------------------------------------------------------------------------------------- - Added a new `position` option that allows control over where the table-of-contents is inserted into the document [Full Changelog](https://github.com/JS-DevTools/rehype-toc/compare/v2.0.0...v2.1.0) [v2.0.0](https://github.com/JS-DevTools/rehype-toc/tree/v2.0.0) (2019-07-10) ---------------------------------------------------------------------------------------------------- ### Breaking Changes - The table of contents is now wrapped in a `<nav>` element by default. You can set the `nav` option to `false` to disable this feature, which will behave exactly like the previous version. [Full Changelog](https://github.com/JS-DevTools/rehype-toc/compare/v1.0.1...v2.0.0) [v1.0.0](https://github.com/JS-DevTools/rehype-toc/tree/v1.0.0) (2019-06-23) ---------------------------------------------------------------------------------------------------- Initial release 🎉