remark-slug
Advanced tools
Package description
The remark-slug npm package is a plugin for the remark Markdown processor that automatically adds slugs to headings in a Markdown document. This is useful for generating links to specific sections of the document, enhancing navigation and accessibility.
Automatic Slug Generation
This feature automatically generates slugs for each heading in a Markdown document. The code sample shows how to use remark-slug with remark and remark-html to convert a Markdown heading into HTML with a slug.
const remark = require('remark');
const remarkHtml = require('remark-html');
const remarkSlug = require('remark-slug');
remark()
.use(remarkSlug)
.use(remarkHtml)
.process('# Hello world', function (err, file) {
console.log(String(file));
});markdown-it-anchor is a plugin for the markdown-it Markdown parser. Similar to remark-slug, it adds anchors to headings in Markdown documents. While remark-slug is specifically designed for the remark ecosystem, markdown-it-anchor serves the markdown-it ecosystem, offering similar functionality but within a different processing environment.
rehype-slug is a plugin for the rehype processor, which is part of the unified.js ecosystem, similar to remark. It adds slugs to HTML elements processed through rehype. This is akin to what remark-slug does but is applied directly to HTML rather than Markdown, making it suitable for projects that work with HTML content at a later stage in the content pipeline.
Readme
remark plugin to add anchors headings using GitHub’s algorithm.
⚠️ Note: This is often useful when compiling to HTML. If you’re doing that, it’s probably smarter to use
remark-rehypeandrehype-slugand benefit from the rehype ecosystem.
This plugin is ready for the new parser in remark
(remarkjs/remark#536).
No change is needed: it works exactly the same now as it did previously!
This package is ESM only:
Node 12+ is needed to use it and it must be imported instead of required.
npm:
npm install remark-slug
Say we have the following file, example.md:
# Lorem ipsum 😪
## dolor—sit—amet
### consectetur & adipisicing
#### elit
##### elit
And our module, example.js, looks as follows:
import fs from 'node:fs'
import {unified} from 'unified'
import remarkParse from 'remark-parse'
import remarkSlug from 'remark-slug'
import remarkRehype from 'remark-rehype'
import rehypeStringify from 'rehype-stringify'
const buf = fs.readFileSync('example.md')
unified()
.use(remarkParse)
.use(remarkSlug)
.use(remarkRehype)
.use(rehypeStringify)
.process(buf)
.then((file) => {
console.log(String(file))
})
Now, running node example yields:
<h1 id="lorem-ipsum-">Lorem ipsum 😪</h1>
<h2 id="dolorsitamet">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 remarkSlug.
unified().use(remarkSlug)Add anchors headings using GitHub’s algorithm.
Uses github-slugger to creates GitHub-style slugs.
Sets data.id and data.hProperties.id on headings.
The first can be used by any plugin as a unique identifier, the second tells
mdast-util-to-hast (used in remark-html and
remark-rehype) to use its value as an id attribute.
Use of remark-slug can open you up to a cross-site scripting (XSS)
attack as it sets id attributes on headings.
In a browser, elements are retrievable by id with JavaScript and CSS.
If a user injects a heading that slugs to an id you are already using,
the user content may impersonate the website.
Always be wary with user input and use rehype-sanitize.
rehype-slug — Add slugs to headings in HTMLSee contributing.md in remarkjs/.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
Legacy remark plugin to add anchors to headings — please use `rehype-slug`
We found that remark-slug demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers 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.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.