cli | ||
lib | ||
node-compress@39b5c39140 | ||
.gitignore | ||
.gitmodules | ||
.jscsrc | ||
.jshintrc | ||
jquery.min.js | ||
MIT-LICENSE.TXT | ||
package.json | ||
README.md |
Inliner
Turns your web page to a single HTML file with everything inlined - perfect for appcache manifests on mobile devices that you want to reduce those http requests.
What it does
- Get a list of all the assets required to drive the page: CSS, JavaScript, images and images used in CSS
- Minify JavaScript (via uglify-js)
- Strips white from CSS
- Base64 encode images
- Puts everything back together as a single HTML file with a simplfied doctype
Installation
Check out a working copy of the source code with Git, or install inliner
via npm (the recommended way). The latter will also install inliner
into the system's bin
path.
$ npm install inliner -g
Or
$ git clone https://github.com/remy/inliner.git
inliner
uses a package.json
to describe the dependancies, and if you install via a github clone, ensure you run npm install
from the inliner
directory to install the dependancies (or manually install jsdom and uglify-js).
Usage
If you have either installed via npm or put the inliner bin directory in your path, then you can use inliner via the command line as per:
inliner http://remysharp.com
This will output the inlined markup with default options. You can see more options on how to disable compression or how not to base64 encode images using the help:
inliner --help
To use inline inside your own script:
var Inliner = require('inliner');
new Inliner('http://remysharp.com', function (html) {
// compressed and inlined HTML page
console.log(html);
});
Or:
var inliner = new Inliner('http://remysharp.com');
inliner.on('progress', function (event) {
console.error(event);
}).on('end', function (html) {
// compressed and inlined HTML page
console.log(html);
});
Note that if you include the inliner script via a git submodule, it requires jsdom & uglifyjs to be installed via npm install jsdom uglify-js
, otherwise you should be good to run.
Once you've inlined the crap out of the page, add the manifest="self.appcache"
to the html
tag and create an empty file called self.appcache (read more).
Support
- Collapses all white space in HTML (except inside
<pre>
elements) - Strips all HTML comments
- Pulls JavaScript and CSS inline to HTML
- Compresses JavaScript via uglify (if not compressed already)
- Converts all images to based64 data urls, both inline images and CSS images
- Imports all @import rules from CSS (recusively)
- Applies media query rules (for print, tv, etc media types)
- Leaves conditional comments in place
- If JavaScript can't be imported (or is Google Analytics), source is not put inline
Limitations / Caveats
- Whitespace compression might get a little heavy handed - all whitespace is collapsed from n spaces to one space.