rehype-ignore
===
[](https://jaywcjlove.github.io/#/sponsor)
[](https://www.npmjs.com/package/rehype-ignore)
[](https://npmjs.org/package/rehype-ignore)
[](https://github.com/jaywcjlove/rehype-ignore/actions/workflows/ci.yml)
[](https://jaywcjlove.github.io/rehype-ignore/lcov-report/)
[](https://github.com/jaywcjlove/rehype-ignore/network/dependents)
Ignore content display via HTML comments, Shown in GitHub readme, excluded in HTML.
## Installation
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c): Node 12+ is needed to use it and it must be `import` instead of `require`.
```bash
npm install rehype-ignore
```
## Options
```ts
export 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;
};
```
## Usage
```js
import { rehype } from 'rehype';
import rehypeIgnore from 'rehype-ignore';
rehype()
.data('settings', { fragment: true })
.use(rehypeIgnore, { })
```
### HTML Example
```html
header
Hello World
```
Output:
```html
header
Hello
```
```js
import { rehype } from 'rehype';
import rehypeIgnore from 'rehype-ignore';
const html = `header
Hello World
`
const htmlStr = rehype()
.data('settings', { fragment: true })
.use(rehypeAttrs, { properties: 'attr' })
.processSync(html)
.toString()
```
### Markdown Example
```markdown
# Hello World
Hello World
Good!
```
Output:
```html
Hello World
Good!
```
```js
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
Hello World
Good!`
const htmlStr = unified()
.use(remarkParse)
.use(remark2rehype, { allowDangerousHtml: true })
.use(rehypeRaw)
.use(rehypeIgnore, { })
.use(stringify)
.processSync(html)
.toString()
```
## Related
- [`rehype-rewrite`](https://github.com/jaywcjlove/rehype-rewrite) Rewrite element with rehype.
- [`rehype-video`](https://github.com/jaywcjlove/rehype-video) Add improved video syntax: links to `.mp4` and `.mov` turn into videos.
- [`rehype-attr`](https://github.com/jaywcjlove/rehype-attr) New syntax to add attributes to Markdown.
- [`rehype-ignore`](https://github.com/jaywcjlove/rehype-ignore) Ignore content display via HTML comments, Shown in GitHub readme, excluded in HTML.
- [`remark-github-blockquote-alert`](https://github.com/jaywcjlove/remark-github-blockquote-alert) Remark plugin to add support for GitHub Alert.
## Contributors
As always, thanks to our amazing contributors!
Made with [action-contributors](https://github.com/jaywcjlove/github-action-contributors).
## License
MIT © [Kenny Wong](https://github.com/jaywcjlove)
