Installation

npm install rehype-ignore

Options

exportdeclaretypeRehypeIgnoreOptions={/**   *  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;};

Usage

import{rehype}from'rehype';importrehypeIgnorefrom'rehype-ignore';rehype().data('settings',{fragment:true}).use(rehypeIgnore,{})

HTML Example

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

<h1>header</h1><p>  Hello</p>

import{rehype}from'rehype';importrehypeIgnorefrom'rehype-ignore';consthtml=`<h1>header</h1><p>  Hello <!--rehype:ignore:start--> <code>World</code> <!--rehype:ignore:end--></p>`consthtmlStr=rehype().data('settings',{fragment:true}).use(rehypeAttrs,{properties:'attr'}).processSync(html).toString()

Markdown Example

#Hello World<!--rehype:ignore:start-->Hello World<!--rehype:ignore:end-->Good!

<h1>Hello World</h1><p>Good!</p>

import{unified}from'unified';importrehypeIgnorefrom'rehype-ignore';importremarkParsefrom'remark-parse';importremark2rehypefrom'remark-rehype';importrehypeRawfrom'rehype-raw';importstringifyfrom'rehype-stringify';consthtml=`# Hello World<!--rehype:ignore:start-->Hello World<!--rehype:ignore:end-->Good!`consthtmlStr=unified().use(remarkParse).use(remark2rehype,{allowDangerousHtml:true}).use(rehypeRaw).use(rehypeIgnore,{}).use(stringify).processSync(html).toString()

Related

Contributors

License