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
:warning: mdast is currently being renamed to remark :warning:
This means all plug-ins and relating projects change too, causing many changes across the ecosystem. Expect the dust to settle in roughly a day.
See this project at the previous stable commit c4a51d1.
Add anchors to remark heading nodes.
Works great with remark-html, used by remark-toc and remark-man.
npm:
npm install remark-slug
remark-slug is also available for bower, component, and duo, and as an AMD, CommonJS, and globals module, uncompressed and compressed.
Dependencies:
var slug = require('remark-slug');
var remark = require('remark');
var html = require('remark-html');
Process:
var doc = remark().use(slug).use(html).process('# Foo bar');
Yields:
<h1 id="foo-bar">Foo bar</h1>
remark ... -u remark-slug
remark ... -u 'remark-slug=library:"npm"'
Adds slugs to markdown headings.
Sets data.id and data.htmlAttributes.id on heading nodes. The first can be
used by any plugin as a unique identifier, the second tells remark-html to
use its value as an id attribute. remark-slug does not overwrite these
values when they already exist.
Parameters:
slug — This plugin;
options (Object?)
'library' — (string or Function, default: 'github'):
'github' — Slugs just like GitHub;
'npm'
— Slugs just like npm (caveat: npm doesn’t support links in
headings, yet);
string (e.g., 'slug', 'slugg')
— Library to require (not in the browser);
Function (e.g., require('slugg'))
— Library to use.
FAQs
Legacy remark plugin to add anchors to headings — please use `rehype-slug`
The npm package remark-slug receives a total of 2,639,639 weekly downloads. As such, remark-slug popularity was classified as popular.
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
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.
Security News
The NVD is facing a significant backlog with over 12,500 CVEs awaiting analysis, and more than 50% of known exploited vulnerabilities (KEVs) left unenriched since mid-February.