htmlnano 2.1.2 → 2.1.3

package/docs/README.md

@@ -1,33 +0,0 @@
-# Website
-
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
-
-## Installation
-
-```console
-yarn install
-```
-
-## Local Development
-
-```console
-yarn start
-```
-
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-
-## Build
-
-```console
-yarn build
-```
-
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-## Deployment
-
-```console
-GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

package/docs/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-    presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-};

package/docs/docs/010-introduction.md

@@ -1,22 +0,0 @@
----
-sidebar_position: 1
-slug: /
----
-
-# Introduction
-
-Modular HTML minifier, built on top of the [PostHTML](https://github.com/posthtml/posthtml).
-Inspired by [cssnano](http://cssnano.co/).
-
-
-## [Benchmark](https://github.com/maltsev/html-minifiers-benchmark/blob/master/README.md)
-[html-minifier-terser@5.1.1]: https://www.npmjs.com/package/html-minifier-terser
-[htmlnano@2.0.0]: https://www.npmjs.com/package/htmlnano
-
-| Website | Source (KB) | [html-minifier-terser@5.1.1] | [htmlnano@2.0.0] |
-|---------|------------:|----------------:|-----------:|
-| [stackoverflow.blog](https://stackoverflow.blog/) | 95 | 87 | 82 |
-| [github.com](https://github.com/) | 210 | 183 | 171 |
-| [en.wikipedia.org](https://en.wikipedia.org/wiki/Main_Page) | 78 | 72 | 72 |
-| [npmjs.com](https://www.npmjs.com/features) | 41 | 38 | 36 |
-| **Avg. minify rate** | 0% | **9%** | **13%** |

package/docs/docs/020-usage.md

@@ -1,117 +0,0 @@
-# Usage
-## Javascript
-```js
-const htmlnano = require('htmlnano');
-const options = {
-    removeEmptyAttributes: false, // Disable the module "removeEmptyAttributes"
-    collapseWhitespace: 'conservative' // Pass options to the module "collapseWhitespace"
-};
-// posthtml, posthtml-render, and posthtml-parse options
-const postHtmlOptions = {
-    sync: true, // https://github.com/posthtml/posthtml#usage
-    lowerCaseTags: true, // https://github.com/posthtml/posthtml-parser#options
-    quoteAllAttributes: false, // https://github.com/posthtml/posthtml-render#options
-};
-
-htmlnano
-    // "preset" arg might be skipped (see "Presets" section below for more info)
-    // "postHtmlOptions" arg might be skipped
-    .process(html, options, preset, postHtmlOptions)
-    .then(function (result) {
-        // result.html is minified
-    })
-    .catch(function (err) {
-        console.error(err);
-    });
-```
-
-
-## PostHTML
-Just add `htmlnano` as a final plugin:
-```js
-const posthtml = require('posthtml');
-const options = {
-    removeComments: false, // Disable the module "removeComments"
-    collapseWhitespace: 'conservative' // Pass options to the module "collapseWhitespace"
-};
-const posthtmlPlugins = [
-    /* other PostHTML plugins */
-
-    require('htmlnano')(options)
-];
-
-const posthtmlOptions = {
-    // See PostHTML docs
-};
-
-posthtml(posthtmlPlugins)
-    .process(html, posthtmlOptions)
-    .then(function (result) {
-        // result.html is minified
-    })
-    .catch(function (err) {
-        console.error(err);
-    });
-```
-
-
-## Webpack
-
-```sh
-npm install html-minimizer-webpack-plugin --save-dev
-npm install htmlnano --save-dev
-```
-
-```js
-// webpack.config.js
-const HtmlMinimizerWebpackPlugin = require('html-minimizer-webpack-plugin');
-const htmlnano = require('htmlnano');
-
-module.exports = {
-    optimization: {
-        minimize: true,
-        minimizer: [
-            // For webpack@5 you can use the `...` syntax to extend existing minimizers (i.e. `terser-webpack-plugin`), uncomment the next line
-            // `...`,
-            new HtmlMinimizerWebpackPlugin({
-                // Add HtmlMinimizerWebpackPlugin's option here, see https://webpack.js.org/plugins/html-minimizer-webpack-plugin/#options
-                // test: /\.html(\?.*)?$/i,
-
-                // Use htmlnano as HtmlMinimizerWebpackPlugin's minimizer
-                minify: htmlnano.htmlMinimizerWebpackPluginMinify,
-                minimizerOptions: {
-                    // Add htmlnano's option here
-                    removeComments: false, // Disable the module "removeComments"
-                    collapseWhitespace: 'conservative' // Pass options to the module "collapseWhitespace"
-                }
-            })
-        ]
-    }
-}
-```
-
-
-
-## Gulp
-```bash
-npm i -D gulp-posthtml htmlnano
-```
-
-```js
-const gulp = require('gulp');
-const posthtml = require('gulp-posthtml');
-const htmlnano = require('htmlnano');
-const options = {
-    removeComments: false
-};
-
-gulp.task('default', function() {
-    return gulp
-        .src('./index.html')
-        .pipe(posthtml([
-            // Add `htmlnano` as a final plugin
-            htmlnano(options)
-        ]))
-        .pipe(gulp.dest('./build'));
-});
-```

package/docs/docs/030-config.md

@@ -1,21 +0,0 @@
-# Config
-
-There are two main ways to configure htmlnano:
-
-## Passing options to `htmlnano` directly
-This is the way described above in the examples.
-
-## Using configuration file
-Alternatively, you might create a configuration file (e.g., `htmlnanorc.json` or `htmlnanorc.js`) or save options to `package.json` with `htmlnano` key.
-`htmlnano` uses `cosmiconfig`, so refer to [its documentation](https://github.com/davidtheclark/cosmiconfig/blob/main/README.md) for a more detailed description.
-
-If you want to specify a preset that way, use `preset` key:
-
-```json
-{
-    "preset": "max",
-}
-```
-
-Configuration files have lower precedence than passing options to `htmlnano` directly.
-So if you use both ways, then the configuration file would be ignored.

package/docs/docs/040-presets.md

@@ -1,75 +0,0 @@
-# Presets
-
-A preset is just an object with modules config.
-
-Currently the following presets are available:
-- [safe](https://github.com/posthtml/htmlnano/blob/master/lib/presets/safe.mjs) — a default preset for minifying a regular HTML in a safe way (without breaking anything)
-- [ampSafe](https://github.com/posthtml/htmlnano/blob/master/lib/presets/ampSafe.mjs) - same as `safe` preset but for [AMP pages](https://www.ampproject.org/)
-- [max](https://github.com/posthtml/htmlnano/blob/master/lib/presets/max.mjs) - maximal minification (might break some pages)
-
-
-You can use them the following way:
-```js
-const htmlnano = require('htmlnano');
-const ampSafePreset = require('htmlnano').presets.ampSafe;
-const options = {
-    // Your options
-};
-
-htmlnano
-    .process(html, options, ampSafePreset)
-    .then(function (result) {
-        // result.html is minified
-    })
-    .catch(function (err) {
-        console.error(err);
-    });
-```
-
-If you skip `preset` argument [`safe`](https://github.com/posthtml/htmlnano/blob/master/lib/presets/safe.mjs) preset would be used by default.
-
-
-If you'd like to define your very own config without any presets pass an empty object as a preset:
-```js
-const htmlnano = require('htmlnano');
-const options = {
-    // Your options
-};
-
-htmlnano
-    .process(html, options, {})
-    .then(function (result) {
-        // result.html is minified
-    })
-    .catch(function (err) {
-        console.error(err);
-    });
-```
-
-
-You might create also your own presets:
-```js
-const htmlnano = require('htmlnano');
-// Preset for minifying email templates
-const emailPreset = {
-    mergeStyles: true,
-    minifyCss: {
-        safe: true
-    },
-};
-
-const options = {
-    // Some specific options
-};
-
-htmlnano
-    .process(html, options, emailPreset)
-    .then(function (result) {
-        // result.html is minified
-    })
-    .catch(function (err) {
-        console.error(err);
-    });
-```
-
-Feel free [to submit a PR](https://github.com/posthtml/htmlnano/issues/new) with your preset if it might be useful for other developers as well.