feat(docs): starting docs

.gitignore

@@ -4,4 +4,5 @@
 ._*
 node_modules
 coverage
+dist
 .history

docs/.vuepress/config.js

@@ -0,0 +1,48 @@
+module.exports = {
+  title: 'Node-minify',
+  description: 'Full documentation of node-minify',
+  head: [['link', { rel: 'manifest', href: '/manifest.json' }], ['meta', { name: 'theme-color', content: '#3eaf7c' }]],
+  serviceWorker: true,
+  evergreen: true,
+  themeConfig: {
+    serviceWorker: {
+      updatePopup: true
+    },
+    nav: [
+      {
+        text: 'Releases',
+        link: 'https://github.com/srod/node-minify/releases'
+      },
+      {
+        text: 'GitHub',
+        link: 'https://github.com/srod/node-minify'
+      },
+      {
+        text: 'NPM',
+        link: 'https://www.npmjs.com/package/node-minify'
+      }
+    ],
+    sidebar: [
+      {
+        title: '',
+        collapsable: false,
+        children: [['', 'Introduction'], 'getting-started', 'options', 'cli']
+      },
+      {
+        title: 'Compressors',
+        collapsable: false,
+        children: [
+          'compressors/babel-minify',
+          'compressors/clean-css',
+          'compressors/crass',
+          'compressors/csso',
+          'compressors/gcc',
+          'compressors/sqwish',
+          'compressors/uglify-es',
+          'compressors/uglify-js',
+          'compressors/yui'
+        ]
+      }
+    ]
+  }
+};

docs/.vuepress/public/manifest.json

@@ -0,0 +1,20 @@
+{
+  "name": "VuePress",
+  "short_name": "VuePress",
+  "icons": [
+    {
+      "src": "/icons/android-chrome-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    },
+    {
+      "src": "/icons/android-chrome-512x512.png",
+      "sizes": "512x512",
+      "type": "image/png"
+    }
+  ],
+  "start_url": "/index.html",
+  "display": "standalone",
+  "background_color": "#fff",
+  "theme_color": "#3eaf7c"
+}

docs/README.md

@@ -0,0 +1,57 @@
+<div align="center"><img src="../static/node-minify.png" width="348" alt="node-minify"></div>
+
+<p align="center">A very light minifier Node.js module.</p>
+
+## Features
+
+It allow you to compress JavaScript and CSS files.
+
+**JavaScript:**
+
+- [babel-minify](/compressors/babel-minify.md)
+- [Google Closure Compiler](/compressors/gcc.md)
+- [uglify-js](/compressors/uglify-js.md)
+- [uglify-es](/compressors/uglify-es.md)
+- [YUI Compressor](/compressors/yui.md)
+
+**CSS:**
+
+- [clean-css](/compressors/clean-css.md)
+- [crass](/compressors/crass.md)
+- [CSSO](/compressors/csso.md)
+- [sqwish](/compressors/sqwish.md)
+- [YUI Compressor](/compressors/yui.md)
+
+**Command Line Interface:**
+
+- [CLI](/cli.md) :tada: new in version 3
+
+CSS benchmark: [http://goalsmashers.github.io/css-minification-benchmark/](http://goalsmashers.github.io/css-minification-benchmark/)
+
+::: tip
+I recommend to execute it at boot time for production use.
+:::
+
+## Warning
+
+It assumes that you have Java installed on your environment for both GCC and YUI Compressor. To check, run:
+
+```bash
+java -version
+```
+
+How to install:
+
+Mac: [https://java.com/en/download/help/mac_install.xml](https://java.com/en/download/help/mac_install.xml)
+
+Windows: [https://java.com/en/download/help/windows_manual_download.xml](https://java.com/en/download/help/windows_manual_download.xml)
+
+Linux: [https://www.java.com/en/download/help/linux_x64_install.xml](https://www.java.com/en/download/help/linux_x64_install.xml)
+
+## Windows support
+
+Since v0.5.0, a windows support is available for the no-compress option and uglify-js (thanks to pieces029 and benpusherhq)
+
+## License
+
+[MIT](https://github.com/srod/node-minify/blob/master/LICENSE)

docs/cli.md

@@ -0,0 +1,21 @@
+# CLI
+
+You can compress files using the command line.
+
+Usage for one or multiple compressors :
+
+```bash
+node-minify --compressor babel-minify --input 'input.js' --output 'output.js'
+```
+
+```bash
+node-minify --compressor 'babel-minify, uglifyjs, gcc' --input 'input.js' --output 'output.js'
+```
+
+Usage for all the compressors :
+
+```bash
+node-minify --compressor all --input 'input.js' --output 'output.js'
+```
+
+<img src="../static/cli.png" width="784" height="433" alt="cli">

docs/compressors/babel-minify.md

@@ -0,0 +1,33 @@
+# babel-minify
+
+`babel-minify` can compress only JavaScript files.
+
+[https://github.com/babel/minify](https://github.com/babel/minify)
+
+## Usage
+
+```js
+compressor.minify({
+  compressor: 'babel-minify',
+  input: 'foo.css',
+  output: 'bar.css',
+  callback: function(err, min) {}
+});
+```
+
+## Options
+
+```js
+compressor.minify({
+  compressor: 'babel-minify',
+  input: 'foo.js',
+  output: 'bar.js',
+  options: {
+    babelrc: 'public/.babelrc',
+    presets: ['env']
+  },
+  callback: function(err, min) {}
+});
+```
+
+[Check all options](https://github.com/babel/minify)

docs/compressors/clean-css.md

@@ -0,0 +1,34 @@
+# clean-css
+
+`clean-css` can compress only CSS files.
+
+[https://github.com/GoalSmashers/clean-css](https://github.com/GoalSmashers/clean-css)
+
+## Usage
+
+```js
+compressor.minify({
+  compressor: 'clean-css',
+  input: 'foo.css',
+  output: 'bar.css',
+  callback: function(err, min) {}
+});
+```
+
+## Options
+
+```js
+compressor.minify({
+  compressor: 'clean-css',
+  input: 'foo.css',
+  output: 'bar.css',
+  options: {
+    advanced: false, // set to false to disable advanced optimizations - selector & property merging, reduction, etc.
+    aggressiveMerging: false // set to false to disable aggressive merging of properties.
+    ... // See more information link below
+  },
+  callback: function (err, min) {}
+});
+```
+
+[Check all options](https://github.com/jakubpawlowicz/clean-css/tree/3.4)

docs/compressors/crass.md

@@ -0,0 +1,16 @@
+# crass
+
+`crass` can compress only CSS files.
+
+[https://github.com/mattbasta/crass](https://github.com/mattbasta/crass)
+
+## Usage
+
+```js
+compressor.minify({
+  compressor: 'crass',
+  input: 'foo.css',
+  output: 'bar.css',
+  callback: function(err, min) {}
+});
+```

docs/compressors/csso.md

@@ -0,0 +1,16 @@
+# CSSO
+
+`CSSO` can compress only CSS files.
+
+[https://github.com/css/csso](https://github.com/css/csso)
+
+## Usage
+
+```js
+compressor.minify({
+  compressor: 'csso',
+  input: 'foo.css',
+  output: 'bar.css',
+  callback: function(err, min) {}
+});
+```

docs/compressors/gcc.md

@@ -0,0 +1,101 @@
+# GCC
+
+`Google Closure Compiler` can compress only JavaScript files.
+
+[https://developers.google.com/closure/compiler/](https://developers.google.com/closure/compiler/)
+
+## Usage (JavaScript version)
+
+```js
+compressor.minify({
+  compressor: 'gcc',
+  input: 'foo.js',
+  output: 'bar.js',
+  callback: function(err, min) {}
+});
+```
+
+[https://www.npmjs.com/package/google-closure-compiler-js](https://www.npmjs.com/package/google-closure-compiler-js)
+
+## Usage (Java >= 1.8)
+
+```js
+compressor.minify({
+  compressor: 'gcc-java',
+  input: 'foo.js',
+  output: 'bar.js',
+  callback: function(err, min) {}
+});
+```
+
+## Usage (Java <= 1.6)
+
+```js
+// Using Google Closure Compiler legacy version for Java 1.6
+compressor.minify({
+  compressor: 'gcc-legacy',
+  input: 'foo.css',
+  output: 'bar.css',
+  callback: function(err, min) {}
+});
+```
+
+## Java
+
+::: warning
+It assumes that you have Java installed on your environment.
+:::
+
+To check, run:
+
+```bash
+java -version
+```
+
+How to install:
+
+Mac: [https://java.com/en/download/help/mac_install.xml](https://java.com/en/download/help/mac_install.xml)
+
+Windows: [https://java.com/en/download/help/windows_manual_download.xml](https://java.com/en/download/help/windows_manual_download.xml)
+
+Linux: [https://www.java.com/en/download/help/linux_x64_install.xml](https://www.java.com/en/download/help/linux_x64_install.xml)
+
+## Options
+
+### Options for Google Closure Compiler (JavaScript version)
+
+```js
+compressor.minify({
+  compressor: 'gcc',
+  input: 'foo.js',
+  output: 'bar.js',
+  options: {
+    createSourceMap: true,
+    compilationLevel: 'WHITESPACE_ONLY',
+    languageIn: 'ECMASCRIPT6'
+    ... // See more information link below
+  },
+  callback: function (err, min) {}
+});
+```
+
+[Check all options](https://github.com/google/closure-compiler-js#flags)
+
+### Options for Google Closure Compiler (Java version)
+
+```js
+compressor.minify({
+  compressor: 'gcc',
+  input: 'foo.js',
+  output: 'bar.js',
+  options: {
+    createSourceMap: true,
+    compilation_level: 'WHITESPACE_ONLY',
+    language: 'ECMASCRIPT6'
+    ... // See more information link below
+  },
+  callback: function (err, min) {}
+});
+```
+
+[Check all options](https://developers.google.com/closure/compiler/docs/api-ref)

docs/compressors/sqwish.md

@@ -0,0 +1,30 @@
+# sqwish
+
+`sqwish` can compress only CSS files.
+
+[https://github.com/ded/sqwish](https://github.com/ded/sqwish)
+
+## Usage
+
+```js
+compressor.minify({
+  compressor: 'sqwish',
+  input: 'foo.css',
+  output: 'bar.css',
+  callback: function(err, min) {}
+});
+```
+
+## Options
+
+```js
+compressor.minify({
+  compressor: 'sqwish',
+  input: 'foo.css',
+  output: 'bar.css',
+  options: {
+    strict: true // strict optimizations
+  },
+  callback: function(err, min) {}
+});
+```