remark-slug

WebJar for remark-slug

License	MIT
GroupId	org.webjars.npm
ArtifactId	remark-slug
Last Version	5.1.2
Release Date	Aug 24, 2019
Type	jar
Description	remark-slug WebJar for remark-slug
Project URL	http://webjars.org
Source Code Management	https://github.com/remarkjs/remark-slug

Download remark-slug

Filename	Size
remark-slug-5.1.2.pom
remark-slug-5.1.2.jar	5 KB
remark-slug-5.1.2-sources.jar	22 bytes
remark-slug-5.1.2-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/remark-slug/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>remark-slug</artifactId>
    <version>5.1.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/remark-slug/
implementation 'org.webjars.npm:remark-slug:5.1.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/remark-slug/
implementation ("org.webjars.npm:remark-slug:5.1.2")

Apache Buildr

'org.webjars.npm:remark-slug:jar:5.1.2'

Apache Ivy

<dependency org="org.webjars.npm" name="remark-slug" rev="5.1.2">
  <artifact name="remark-slug" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='remark-slug', version='5.1.2')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "remark-slug" % "5.1.2"

Leiningen

[org.webjars.npm/remark-slug "5.1.2"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.webjars.npm : github-slugger	jar	[1.0.0,2)
org.webjars.npm : mdast-util-to-string	jar	[1.0.0,2)
org.webjars.npm : unist-util-visit	jar	[1.0.0,2)

Project Modules

There are no modules declared in this project.

remark-slug

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-rehype and rehype-slug and benefit from the rehype ecosystem.

Note!

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!

Install

npm:

npm install remark-slug

Use

Say we have the following file, example.md:

# Lorem ipsum 😪

## dolor—sit—amet

### consectetur & adipisicing

#### elit

##### elit

And our script, example.js, looks as follows:

var fs = require('fs')
var unified = require('unified')
var markdown = require('remark-parse')
var slug = require('remark-slug')
var remark2rehype = require('remark-rehype')
var html = require('rehype-stringify')

unified()
  .use(markdown)
  .use(slug)
  .use(remark2rehype)
  .use(html)
  .process(fs.readFileSync('example.md'), function(err, file) {
    if (err) throw err
    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 &#x26; adipisicing</h3>
<h4 id="elit">elit</h4>
<h5 id="elit-1">elit</h5>

API

remark().use(slug)

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.

Security

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.

Related

• rehype-slug — Add slugs to headings in HTML

Contribute

See 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.

License

MIT © Titus Wormer

remark

markdown processor powered by plugins part of the @unifiedjs collective

Versions

Version
5.1.2 Aug 24, 2019