rehype-ignore

Ignore content display via HTML comments, Shown in GitHub readme, excluded in HTML.

Installation

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

1npm install rehype-ignore

Options

1export declare type RehypeIgnoreOptions = {
2  /**
3   *  Character to use for opening delimiter, by default `rehype:ignore:start`
4   */
5  openDelimiter?: string;
6  /**
7   * Character to use for closing delimiter, by default `rehype:ignore:end`
8   */
9  closeDelimiter?: string;
10};

Usage

1import { rehype } from 'rehype';
2import rehypeIgnore from 'rehype-ignore';
3
4rehype()
5  .data('settings', { fragment: true })
6  .use(rehypeIgnore, { })

HTML Example

1<h1>header</h1>
2<p>
3  Hello <!--rehype:ignore:start--> <code>World</code> <!--rehype:ignore:end-->
4</p>

Output:

1<h1>header</h1>
2<p>
3  Hello </p>

1import { rehype } from 'rehype';
2import rehypeIgnore from 'rehype-ignore';
3
4const html = `<h1>header</h1>
5<p>
6  Hello <!--rehype:ignore:start--> <code>World</code> <!--rehype:ignore:end-->
7</p>`
8
9const htmlStr = rehype()
10  .data('settings', { fragment: true })
11  .use(rehypeAttrs, { properties: 'attr' })
12  .processSync(html)
13  .toString()

Markdown Example

1# Hello World
2
3<!--rehype:ignore:start-->Hello World<!--rehype:ignore:end-->
4
5Good!

Output:

1<h1>Hello World</h1>
2
3<p>Good!</p>

1import { unified } from 'unified';
2import rehypeIgnore from 'rehype-ignore';
3import remarkParse from 'remark-parse';
4import remark2rehype from 'remark-rehype';
5import rehypeRaw from 'rehype-raw';
6import stringify from 'rehype-stringify';
7
8const html = `# Hello World
9
10<!--rehype:ignore:start-->Hello World<!--rehype:ignore:end-->
11
12Good!`
13
14const htmlStr = unified()
15  .use(remarkParse)
16  .use(remark2rehype, { allowDangerousHtml: true })
17  .use(rehypeRaw)
18  .use(rehypeIgnore, { })
19  .use(stringify)
20  .processSync(html)
21  .toString()

Related

• rehype-rewrite Rewrite element with rehype.
• rehype-video 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