From 17083b4a2a23a66027e0d02fcd34998d0415c50c Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Sat, 17 Nov 2018 19:15:52 +0100 Subject: [PATCH] Update `readme.md` --- packages/rehype-preset-minify/readme.md | 55 +++++++++++++++++++++---- readme.md | 6 ++- 2 files changed, 52 insertions(+), 9 deletions(-) diff --git a/packages/rehype-preset-minify/readme.md b/packages/rehype-preset-minify/readme.md index 3006af0..0cfa68d 100644 --- a/packages/rehype-preset-minify/readme.md +++ b/packages/rehype-preset-minify/readme.md @@ -1,9 +1,44 @@ -# rehype-preset-minify [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat] +# rehype-preset-minify -**rehype-preset-minify** minifies and mangles HTML with [**rehype**][rehype]. +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Chat][chat-badge]][chat] + +**rehype-preset-minify** is an HTML minifier based on [**rehype**][rehype]. + +##### In + +```html + + + + + + + + Foo & bar + + +

bar bar

+

foo bar

+ + + +``` + +##### Out + +```html +Foo & bar

bar bar

foo bar

+``` ## Install +[npm][]: + ```sh npm install rehype-preset-minify ``` @@ -57,7 +92,7 @@ rehype() Yields: ```html -Hello

World!

+Hello

World!

``` ## License @@ -68,15 +103,21 @@ Yields: [build-badge]: https://img.shields.io/travis/rehypejs/rehype-minify.svg -[build-status]: https://travis-ci.org/rehypejs/rehype-minify +[build]: https://travis-ci.org/rehypejs/rehype-minify [coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype-minify.svg -[coverage-status]: https://codecov.io/github/rehypejs/rehype-minify +[coverage]: https://codecov.io/github/rehypejs/rehype-minify + +[downloads-badge]: https://img.shields.io/npm/dm/rehype-preset-minify.svg + +[downloads]: https://www.npmjs.com/package/rehype-preset-minify + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg -[chat-badge]: https://img.shields.io/gitter/room/rehypejs/Lobby.svg +[chat]: https://spectrum.chat/unified/rehype -[chat]: https://gitter.im/rehypejs/Lobby +[npm]: https://docs.npmjs.com/cli/install [author]: https://wooorm.com diff --git a/readme.md b/readme.md index d8c5f38..6adf7c0 100644 --- a/readme.md +++ b/readme.md @@ -32,12 +32,12 @@ ##### Out ```html -Foo & bar

bar bar

foo bar

+Foo & bar

bar bar

foo bar

``` ## Install -Install: +[npm][]: ```sh npm install rehype-preset-minify @@ -132,6 +132,8 @@ repository, organisation, or community you agree to abide by its terms. [chat]: https://spectrum.chat/unified/rehype +[npm]: https://docs.npmjs.com/cli/install + [license]: license [author]: https://wooorm.com