sgauthier
6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
116 lines
2.7 KiB
Markdown
116 lines
2.7 KiB
Markdown
<!--This file is generated by `build-packages.js`-->
|
|
|
|
# rehype-minify-whitespace
|
|
|
|
[![Build][build-badge]][build]
|
|
[![Coverage][coverage-badge]][coverage]
|
|
[![Downloads][downloads-badge]][downloads]
|
|
[![Size][size-badge]][size]
|
|
[![Sponsors][sponsors-badge]][collective]
|
|
[![Backers][backers-badge]][collective]
|
|
[![Chat][chat-badge]][chat]
|
|
|
|
Collapse whitespace.
|
|
|
|
Normally, collapses to a single space.
|
|
If `newlines: true`, collapses whitespace containing newlines to `'\n'`
|
|
instead of `' '`.
|
|
|
|
## Install
|
|
|
|
[npm][]:
|
|
|
|
```sh
|
|
npm install rehype-minify-whitespace
|
|
```
|
|
|
|
## Use
|
|
|
|
On the API:
|
|
|
|
```diff
|
|
unified()
|
|
.use(require('rehype-parse'))
|
|
+ .use(require('rehype-minify-whitespace'))
|
|
.use(require('rehype-stringify'))
|
|
.process('<span>some html</span>', function (err, file) {
|
|
console.error(report(err || file))
|
|
console.log(String(file))
|
|
})
|
|
```
|
|
|
|
On the CLI:
|
|
|
|
```sh
|
|
rehype input.html --use minify-whitespace > output.html
|
|
```
|
|
|
|
## Example
|
|
|
|
##### In
|
|
|
|
```html
|
|
<h1>Heading</h1>
|
|
<p><strong>This</strong> and <em>that</em></p>
|
|
```
|
|
|
|
##### Out
|
|
|
|
```html
|
|
<h1>Heading</h1><p><strong>This</strong> and <em>that</em></p>
|
|
```
|
|
|
|
## Contribute
|
|
|
|
See [`contributing.md`][contributing] in [`rehypejs/.github`][health] for ways
|
|
to get started.
|
|
See [`support.md`][support] for ways to get help.
|
|
|
|
This project has a [code of conduct][coc].
|
|
By interacting with this repository, organization, or community you agree to
|
|
abide by its terms.
|
|
|
|
## License
|
|
|
|
[MIT][license] © [Titus Wormer][author]
|
|
|
|
[build-badge]: https://img.shields.io/travis/rehypejs/rehype-minify.svg
|
|
|
|
[build]: https://travis-ci.org/rehypejs/rehype-minify
|
|
|
|
[coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype-minify.svg
|
|
|
|
[coverage]: https://codecov.io/github/rehypejs/rehype-minify
|
|
|
|
[downloads-badge]: https://img.shields.io/npm/dm/rehype-minify-whitespace.svg
|
|
|
|
[downloads]: https://www.npmjs.com/package/rehype-minify-whitespace
|
|
|
|
[size-badge]: https://img.shields.io/bundlephobia/minzip/rehype-minify-whitespace.svg
|
|
|
|
[size]: https://bundlephobia.com/result?p=rehype-minify-whitespace
|
|
|
|
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
|
|
|
|
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
|
|
|
|
[collective]: https://opencollective.com/unified
|
|
|
|
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
|
|
|
[chat]: https://github.com/rehypejs/rehype/discussions
|
|
|
|
[npm]: https://docs.npmjs.com/cli/install
|
|
|
|
[health]: https://github.com/rehypejs/.github
|
|
|
|
[contributing]: https://github.com/rehypejs/.github/blob/main/contributing.md
|
|
|
|
[support]: https://github.com/rehypejs/.github/blob/main/support.md
|
|
|
|
[coc]: https://github.com/rehypejs/.github/blob/main/code-of-conduct.md
|
|
|
|
[license]: https://github.com/rehypejs/rehype-minify/blob/main/license
|
|
|
|
[author]: https://wooorm.com
|