Ignore content display via HTML comments, Shown in GitHub readme, excluded in HTML.
This package is ESM only: Node 12+ is needed to use it and it must be import instead of require.
npm install rehype-ignoreexport declare type RehypeIgnoreOptions = {
/**
* Character to use for opening delimiter, by default `rehype:ignore:start`
*/
openDelimiter?: string;
/**
* Character to use for closing delimiter, by default `rehype:ignore:end`
*/
closeDelimiter?: string;
};import { rehype } from 'rehype';
import rehypeIgnore from 'rehype-ignore';
rehype()
.data('settings', { fragment: true })
.use(rehypeIgnore, { })<h1>header</h1>
<p>
Hello <!--rehype:ignore:start--> <code>World</code> <!--rehype:ignore:end-->
</p>Output:
<h1>header</h1>
<p>
Hello </p>import { rehype } from 'rehype';
import rehypeIgnore from 'rehype-ignore';
const html = `<h1>header</h1>
<p>
Hello <!--rehype:ignore:start--> <code>World</code> <!--rehype:ignore:end-->
</p>`
const htmlStr = rehype()
.data('settings', { fragment: true })
.use(rehypeAttrs, { properties: 'attr' })
.processSync(html)
.toString()# Hello World
<!--rehype:ignore:start-->Hello World<!--rehype:ignore:end-->
Good!Output:
<h1>Hello World</h1>
<p>Good!</p>import { unified } from 'unified';
import rehypeIgnore from 'rehype-ignore';
import remarkParse from 'remark-parse';
import remark2rehype from 'remark-rehype';
import rehypeRaw from 'rehype-raw';
import stringify from 'rehype-stringify';
const html = `# Hello World
<!--rehype:ignore:start-->Hello World<!--rehype:ignore:end-->
Good!`
const htmlStr = unified()
.use(remarkParse)
.use(remark2rehype, { allowDangerousHtml: true })
.use(rehypeRaw)
.use(rehypeIgnore, { })
.use(stringify)
.processSync(html)
.toString()rehype-rewriteRewrite element with rehype.rehype-videoAdd improved video syntax: links to.mp4and.movturn into videos.rehype-attrNew syntax to add attributes to Markdown.rehype-ignoreIgnore content display via HTML comments, Shown in GitHub readme, excluded in HTML.remark-github-blockquote-alertRemark plugin to add support for GitHub Alert.
As always, thanks to our amazing contributors!
Made with action-contributors.
MIT © Kenny Wong
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent