rehype-rewrite
v4.0.4TypeScript
Rewrite element with rehype.
0/weekUpdated 1 months agoMITUnpacked: 26.8 KB
Published by Kenny Wong
npm install rehype-rewrite
rehype-rewrite
===
Rewrite element with rehype.
Installation
This package is ESM only: Node 12+ is needed to use it and it must be import instead of require.
``bash`
npm install rehype-rewrite
Usage
> 🚧 Migrate from rehype-rewrite ~~v2.x~~ to v3.x.`
>
> diff`
> rehype()
> - .use(rehypeRewrite, (node, index, parent) => {})
> + .use(rehypeRewrite, {
> + rewrite: (node, index, parent) => {}
> + })
>
`js
import { rehype } from 'rehype';
import rehypeRewrite from 'rehype-rewrite';
import stringify from 'rehype-stringify';
const html =
header
;
const htmlStr = rehype()
.data('settings', { fragment: true })
.use(rehypeRewrite, {
rewrite: (node, index, parent) => {
if(node.type == 'text' && node.value == 'header') {
node.value = ''
}
}
})
.use(stringify)
.processSync(html)
.toString()
`>
html
> header
> `
>
>
> `html
>
> `
> Options
ts
import { Plugin } from 'unified';
import { Root, Element, ElementContent, RootContent } from 'hast';
/* Get the node tree source code string /
export declare const getCodeString: (data?: ElementContent[], code?: string) => string;
export declare type RehypeRewriteOptions = {
/**
* Select an element to be wrapped. Expects a string selector that can be passed to hast-util-select (supported selectors).
* If selector is not set then wrap will check for a body all elements.
*/
selector?: string;
/* Rewrite Element. /
rewrite(node: Root | RootContent, index: number | null, parent: Root | Element | null): void;
};
declare const remarkRewrite: Plugin<[RehypeRewriteOptions?], Root>;
export default remarkRewrite;
`$3
Select an element to be wrapped. Expects a string selector that can be passed to hast-util-select (supported selectors). If
is not set then wrap will check for a body all elements.$3
Rewrite element.
Example
$3
`js
import { rehype } from 'rehype';
import rehypeRewrite from 'rehype-rewrite';
import stringify from 'rehype-stringify';const html =
header
header
header
;
const htmlStr = rehype()
.data('settings', { fragment: true })
.use(rehypeRewrite, {
selector: 'h1',
rewrite: (node) => {
if (node.type === 'element') {
node.properties.className = 'test';
}
}
})
.use(stringify)
.processSync(html)
.toString()
`>
html
> header
> header
> header
> `
>
>
> `html
> header
> header
> header
> `
>$3
js
import { rehype } from 'rehype';
import rehypeRewrite from 'rehype-rewrite';
import stringify from 'rehype-stringify';const html =
header
;
const htmlStr = rehype()
.use(rehypeRewrite, {
rewrite: (node) => {
if (node.type == 'element' && node.tagName == 'body') {
node.properties = { ...node.properties, style: 'color:red;'}
}
}
})
.use(stringify)
.processSync(html)
.toString()
`>
html
> header
> `
>
>
> `html
> header
> `
>$3
js
import { rehype } from 'rehype';
import rehypeRewrite from 'rehype-rewrite';
import stringify from 'rehype-stringify';const html =
hello
;
const htmlStr = rehype()
.data('settings', { fragment: true })
.use(rehypeRewrite, {
rewrite: (node) => {
if (node.type == 'element' && node.tagName == 'h1') {
node.children = [ ...node.children, {
type: 'element',
tagName: 'span',
properties: {},
children: [
{type: 'text', value: ' world'}
]
}]
}
}
})
.use(stringify)
.processSync(html)
.toString()
`>
html
> hello
> `
>
>
> `html
> hello world
> `
> $3
js
import { unified } from 'unified';
import remarkParse from 'remark-parse';
import rehypeRaw from 'rehype-raw';
import remark2rehype from 'remark-rehype';
import rehypeRewrite from 'rehype-rewrite';
import stringify from 'rehype-stringify';const html =
hello
;
const htmlStr = unified()
.use(remarkParse)
.use(remark2rehype, { allowDangerousHtml: true })
.use(rehypeRaw)
.use(rehypeRewrite, {
rewrite: (node) => {
if (node.type == 'element' && node.tagName == 'h1') {
node.properties = { ...node.properties, style: 'color:red;' }
}
}
})
.use(stringify)
.processSync(html)
.toString()
`>
html
> hello
> `
>
>
>
> `html
> Hello World!
> `
> Related
Add improved video syntax: links to .mp4 and .mov turn into videos.
- rehype-attr New syntax to add attributes to Markdown.
- rehype-ignore Ignore content display via HTML comments, Shown in GitHub readme, excluded in HTML.
- remark-github-blockquote-alert` Remark plugin to add support for GitHub Alert.Contributors
As always, thanks to our amazing contributors!
Made with action-contributors.
License
MIT © Kenny Wong