UNPKG

htmlcompile

Version:

Compile, optimize and compress anything to HTML.

74 lines (46 loc) 2.12 kB
# HTMLCompile > Compile, optimize and compress anything to HTML. [![Travis Status](https://travis-ci.org/cjpatoilo/htmlcompile.svg?branch=master)](https://travis-ci.org/cjpatoilo/htmlcompile?branch=master) [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/fit27aie1vb9fk9x?svg=true)](https://ci.appveyor.com/project/cjpatoilo/htmlcompile) [![Codacy Status](https://img.shields.io/codacy/grade/2b3d20fb1e2847bbbf7a1eaeebbae183/master.svg)](https://www.codacy.com/app/cjpatoilo/htmlcompile/dashboard) [![Dependencies Status](https://david-dm.org/cjpatoilo/htmlcompile.svg)](https://david-dm.org/cjpatoilo/htmlcompile) [![Version Status](https://badge.fury.io/js/htmlcompile.svg)](https://www.npmjs.com/package/htmlcompile) [![Download Status](https://img.shields.io/npm/dt/htmlcompile.svg)](https://www.npmjs.com/package/htmlcompile) [![Gitter Chat](https://img.shields.io/badge/gitter-join_the_chat-4cc61e.svg)](https://gitter.im/cjpatoilo/htmlcompile) ## Why it's awesome No spend several hours setting configuration files. **HTMLCompile** will compile, optimize and compress anything to HTML. Set folder name where the source code is located and we'll take care of the rest for you. Just it! _NOTE: For now only works with Pug, Jade, EJS, Haml, Handlebars, Hogan and HTML._ ## Getting Started **Install with npm** ``` $ npm install htmlcompile ``` **Install with Yarn** ``` $ yarn add htmlcompile ``` **Run with npx (without installing)** ``` $ npx install htmlcompile ``` **Usage** ``` $ htmlcompile src dist ``` _NOTE: Only the folder name is required._ ## CLI ``` $ htmlcompile --help Usage: $ htmlcompile <input> [<output>] [<options>] Options: -h, --help Display help information -v, --version Output version Examples: $ htmlcompile src $ htmlcompile src dist ``` ## Contributing Want to contribute? Follow these [recommendations](https://github.com/cjpatoilo/htmlcompile/contribute). ## License Designed with ♥ by [CJ Patoilo](https://twitter.com/cjpatoilo). Licensed under the [MIT License](https://cjpatoilo.com/license).