Socket
Socket
Sign inDemoInstall

rehype-slug

Package Overview
Dependencies
Maintainers
2
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

rehype-slug

rehype plugin to add `id` attributes to headings


Version published
Weekly downloads
2.7M
increased by1.39%
Maintainers
2
Weekly downloads
 
Created

What is rehype-slug?

The rehype-slug npm package is a plugin for the rehype ecosystem, which is used to process HTML with plugins. This particular plugin automatically adds slugs (URL-friendly identifiers) to headings in HTML documents. These slugs can be used to create anchor links for easy navigation within the document, enhancing the usability and accessibility of web pages.

What are rehype-slug's main functionalities?

Automatic Slug Generation for Headings

This feature automatically generates slugs for each heading in an HTML document. The code sample shows how to use rehype with the rehype-slug plugin to process an HTML string containing a heading, adding an id attribute to the heading based on its content.

const rehype = require('rehype');
const rehypeSlug = require('rehype-slug');

rehype()
  .use(rehypeSlug)
  .process('<h1>Your Heading Here</h1>', function(err, file) {
    console.log(String(file));
  });

Other packages similar to rehype-slug

Keywords

FAQs

Package last updated on 31 Aug 2023

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc