Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

rehype-attr

Package Overview
Dependencies
Maintainers
1
Versions
39
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

rehype-attr

New syntax to add attributes to Markdown.

  • 3.0.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

rehype-attr

Buy me a coffee Downloads NPM version Build Coverage Status Repo Dependents

New syntax to add attributes to Markdown. rehype-attr like remark-attr

Installation

This package is ESM only: Node 12+ is needed to use it and it must be import instead of require.

npm install rehype-attr

Default Syntax

HTML Example
<a href="https://github.com">github</a><!--rehype:rel=external&style=color:pink;&data-name=kenny-->

Output:

<a href="https://github.com" rel="external" style="color:pink;" data-name="kenny">github</a>
Example Code
import { rehype } from 'rehype';
import rehypeAttrs from 'rehype-attr';

const htmlStr = rehype()
  .data('settings', { fragment: true })
  .use(rehypeAttrs, { properties: 'attr' })
  .processSync(`<a href="https://github.com">github</a><!--rehype:rel=external-->`)
  .toString()
Markdown Example
[github](https://github.com)<!--rehype:rel=external-->

Output:

<p>
  <a href="https://github.com" rel="external">github</a>
  <!--rehype:rel=external-->
</p>
Example Code
import { unified } from 'unified';
import stringify from 'rehype-stringify';
import rehypeRaw from 'rehype-raw';
import remark2rehype from 'remark-rehype';
import remarkParse from 'remark-parse';
import rehypeAttrs from 'rehype-attr';

const htmlStr = unified()
  .use(remarkParse)
  .use(remark2rehype, { allowDangerousHtml: true })
  .use(rehypeRaw)
  .use(rehypeAttrs, { properties: 'attr' })
  .use(stringify)
  .processSync(`[github](https://github.com)<!--rehype:rel=external-->`)
  .toString()

Header

HTML Example
<h1>This is a title</h1><!--rehype:style=color:pink;-->

Output:

<h1 style="color:pink;">This is a title</h1>
Example Code
import { rehype } from 'rehype';
import rehypeAttrs from 'rehype-attr';

const htmlStr = rehype()
  .data('settings', { fragment: true })
  .use(rehypeAttrs, { properties: 'attr' })
  .processSync(`<h1>This is a title</h1><!--rehype:style=color:pink;-->`)
  .toString()
Markdown Example
This is a title
====
<!--rehype:style=color:pink;-->

Output:

<h1 style="color:pink;">This is a title</h1>
# This is a title
<!--rehype:style=color:pink;-->

Output:

<h1 style="color:pink;">This is a title</h1>

Strong

HTML Example
This is a <strong>Unicorn</strong><!--rehype:style=color: grey-->

Output:

This is a <strong style="color: grey">Unicorn</strong>
Markdown Example
This is a **Unicorn**<!--rehype:style=color: grey-->

Output:

<p>This is a <strong style="color: grey">Unicorn</strong> <!--rehype:style=color: grey--></p>

Emphasis

HTML Example
Npm stand for <em>node</em><!--rehype:style=color: red--> packet manager.

Output:

Npm stand for <em style="color: red">node</em> packet manager.
Markdown Example
Npm stand for *node* <!--rehype:style=color: red--> packet manager.

Output:

<p>Npm stand for <em style="color: red">node</em><!--rehype:style=color: red--> packet manager.</p>

Code

<!--rehype:title=Rehype Attrs&abc=1&hello=2-->
\```js
console.log('')
\```

Output:

<pre data-type="rehyp">
  <code class="language-js" data-config="[object Object]">
    console.log('')
  </code>
</pre>

Inlne Code

HTML Example
This is the <code>content</code><!--rehype:style=color:pink;-->

Output:

This is the <code style="color:pink;">content</code>
Markdown Example
This is the `content`<!--rehype:style=color:pink;-->

Output:

<p>This is the <code style="color:pink;">content</code><!--rehype:style=color:pink;--></p>

List

- list
<!--rehype:style=width:100px;-->

Output:

<ul style="width:100px;">
  <li>list</li>
</ul>
<!--rehype:style=width:100px;-->
HTML Example
import { rehype } from 'rehype';
import rehypeAttrs from 'rehype-attr';

const htmlStr = rehype()
  .data('settings', { fragment: true })
  .use(rehypeAttrs, { properties: 'attr' })
  .processSync(`<a href="https://github.com">github</a><!--rehype:rel=external-->`)
  .toString()

Output:

<h1 style="color:pink;">This is a title</h1>
Markdown Example
import { unified } from 'unified';
import stringify from 'rehype-stringify';
import rehypeRaw from 'rehype-raw';
import remarkParse from 'remark-parse';
import remark2rehype from 'remark-rehype';
import rehypeAttrs from 'rehype-attr';

const mrkStr = `[github](https://github.com)<!--rehype:rel=external-->`
const htmlStr = unified()
  .use(remarkParse)
  .use(remark2rehype, { allowDangerousHtml: true })
  .use(rehypeRaw)
  .use(rehypeAttrs, { properties: 'attr' })
  .use(stringify)
  .processSync(mrkStr)
  .toString()

Output:

<p>
  <a href="https://github.com" rel="external">github</a>
  <!--rehype:rel=external-->
</p>

Options

properties

Default Value: data
Value: data, string, attr

codeBlockParames

Code block passing parameters

Default Value: true

  • rehype-video Add improved video syntax: links to .mp4 and .mov turn into videos.
  • rehype-rewrite Rewrite element with rehype.
  • rehype-ignore Ignore content display via HTML comments, Shown in GitHub readme, excluded in HTML.
  • rehypejs HTML processor powered by plugins part of the @unifiedjs collective
  • remark-parse remark plugin to parse Markdown
  • remark-rehype remark plugin to transform to rehype
  • rehype-raw rehype plugin to reparse the tree (and raw nodes)
  • rehype-stringify rehype plugin to serialize HTML

Contributors

As always, thanks to our amazing contributors!

Made with github-action-contributors.

License

MIT © Kenny Wong

Keywords

FAQs

Package last updated on 26 Nov 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