Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 4.14 KB

README.md

File metadata and controls

88 lines (58 loc) · 4.14 KB
Raw

Welcome to Minify!

Minify is an HTTP server for JS and CSS assets. It compresses and combines files and serves it with appropriate headers, allowing conditional GET or long-Expires.

Before 7 requests
After 2 requests

The stats above are from a brief walkthrough which shows how easy it is to set up Minify on an existing site. It eliminated 5 HTTP requests and reduced JS/CSS bandwidth by 70%.

Relative URLs in CSS files are rewritten to compensate for being served from a different directory.

Wordpress User?

Consider instead using a dedicated WordPress plugin for more deep integration and simpler installation. E.g.:

Unfortunately we can't support the WordPress plugins here.

Installation

Installation requires PHP 5.3+, SSH access, and access to tools like git and composer or the privileges to install them.

cd /path/to/public_html
git clone https://github.com/mrclay/minify.git min
cd min
composer install

What this does:

  1. Inside your DOCUMENT_ROOT directory, we clone this repo. Otherwise you may download and extract the zip file.
  2. We rename this directory min. E.g. You will have something like: /home/example/public_html/min
  3. We cd into it and run composer install to install the dependencies.

You can verify that it is working by visiting these two URLs:

* http://example.org/min/?f=min/quick-test.js
* http://example.org/min/?f=min/quick-test.css

If your server supports mod_rewrite, this URL should also work:

Configuration & Usage

See the user guide!

Minify also comes with a URI Builder application that can help you write URLs for use with Minify or configure groups of files.

See the cookbook for more advanced options for minification.

More docs are available.

Support

Google Group

Unit Testing

  1. Open the file min_unit_tests/_inc.php.
  2. Enable the file by commenting out the die() statement.
  3. Access: http://example.org/min/min_unit_tests/test_all.php (If you wish, the other test_*.php files can be run to test individual components with more verbose output.)
  4. Re-disable the _inc.php file when you are done.

Warnings

  • Minify is designed for efficiency, but, for very high traffic sites, it will probably serve files slower than your HTTPd due to the CGI overhead of PHP. See the FAQ and CookBook for more info.
  • If you combine a lot of CSS, watch out for IE's 4096 selectors-per-file limit, affects IE 6 through 9.
  • Minify should work fine with files encoded in UTF-8 or other 8-bit encodings like ISO 8859/Windows-1252. By default Minify appends ";charset=utf-8" to the Content-Type headers it sends.

Acknowledgments

Minify was inspired by jscsscomp by Maxim Martynyuk and by the article Supercharged JavaScript by Patrick Hunlock.

The JSMin library used for !JavaScript minification was originally written by Douglas Crockford and was ported to PHP by Ryan Grove specifically for use in Minify.