Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@jolduca/rehype-slug
Advanced tools
Readme
rehype plugin to add id
s to headings.
This package is a unified (rehype) plugin to add id
s to headings.
It looks for headings (so <h1>
through <h6>
) that do not yet have id
s
and adds id
attributes to them based on the text they contain.
The algorithm that does this is github-slugger
, which
matches how GitHub works.
unified is a project that transforms content with abstract syntax trees
(ASTs).
rehype adds support for HTML to unified.
hast is the HTML AST that rehype uses.
This is a rehype plugin that adds id
s to headings in the AST.
This plugin is useful when you have relatively long documents and you want to be able to link to particular sections.
A different plugin, rehype-autolink-headings
, adds
links to these headings back to themselves, which is useful as it lets users
more easily link to particular sections.
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install rehype-slug
In Deno with esm.sh
:
import rehypeSlug from 'https://esm.sh/rehype-slug@5'
In browsers with esm.sh
:
<script type="module">
import rehypeSlug from 'https://esm.sh/rehype-slug@5?bundle'
</script>
Say we have the following file example.html
:
<h1 id=some-id>Lorem ipsum</h1>
<h2>Dolor sit amet 😪</h2>
<h3>consectetur & adipisicing</h3>
<h4>elit</h4>
<h5>elit</h5>
And our module example.js
looks as follows:
import {read} from 'to-vfile'
import {rehype} from 'rehype'
import rehypeSlug from 'rehype-slug'
main()
async function main() {
const file = await rehype()
.data('settings', {fragment: true})
.use(rehypeSlug)
.process(await read('example.html'))
console.log(String(file))
}
Now, running node example.js
yields:
<h1 id="some-id">Lorem ipsum</h1>
<h2 id="dolor-sit-amet-">Dolor sit amet 😪</h2>
<h3 id="consectetur--adipisicing">consectetur & adipisicing</h3>
<h4 id="elit">elit</h4>
<h5 id="elit-1">elit</h5>
This package exports no identifiers.
The default export is rehypeSlug
.
unified().use(rehypeSlug)
Add id
s to headings.
There are no options.
This package is fully typed with TypeScript. There are no extra exported types.
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
This plugin works with rehype-parse
version 1+, rehype-stringify
version 1+,
rehype
version 1+, and unified
version 4+.
Use of rehype-slug
can open you up to a cross-site scripting (XSS)
attack as it sets id
attributes on headings, which causes what is known
as “DOM clobbering”.
Please use rehype-sanitize
and see its
Example: headings (DOM clobbering) for information on
how to properly solve it.
rehype-autolink-headings
— add links to headings with IDs back to themselvesSee contributing.md
in rehypejs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
rehype plugin to add `id` attributes to headings
The npm package @jolduca/rehype-slug receives a total of 0 weekly downloads. As such, @jolduca/rehype-slug popularity was classified as not popular.
We found that @jolduca/rehype-slug demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.