https://github.com/remarkjs/remark-slug

Legacy plugin to add `id`s to headings — please use `rehype-slug`
https://github.com/remarkjs/remark-slug

heading link markdown remark remark-plugin slug

Last synced: 20 days ago
JSON representation

Legacy plugin to add `id`s to headings — please use `rehype-slug`

• Host: GitHub
• URL: https://github.com/remarkjs/remark-slug
• Owner: remarkjs
• License: mit
• Created: 2015-07-05T20:23:30.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2021-10-24T13:02:18.000Z (over 2 years ago)
• Last Synced: 2024-05-19T23:41:31.003Z (about 1 month ago)
• Topics: heading, link, markdown, remark, remark-plugin, slug
• Language: JavaScript
• Homepage: https://remark.js.org
• Size: 132 KB
• Stars: 89
• Watchers: 9
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Lists

• awesome-stars - remarkjs/remark-slug - Legacy plugin to add `id`s to headings — please use `rehype-slug` (JavaScript)

README

        
# remark-slug

**Stability: Legacy**.

This package is no longer recommended for use.

It’s still covered by semantic-versioning guarantees and not yet deprecated,

but use of this package should be avoided.

Please use `remark-rehype` to move from remark (markdown) to rehype (HTML)

and then replace `remark-slug` with

[`rehype-slug`](https://github.com/rehypejs/rehype-slug).

Legacy

[documentation for this package](https://github.com/remarkjs/remark-slug/tree/8e6394c)

is still available in Git.

## License

[MIT][license] © [Titus Wormer][author]

[license]: license

[author]: https://wooorm.com