15 Commits

Author SHA1 Message Date
Alexandre Gigliotti
4a3b6f9d50 0.1.6 2015-08-17 09:17:57 -07:00
Alexandre Gigliotti
5b88484888 Updated README. 2015-08-17 09:17:50 -07:00
Alexandre Gigliotti
dff5f1160b 0.1.5 2015-08-10 08:55:48 -07:00
Alexandre Gigliotti
abb3dd95a7 Updated README. 2015-08-10 08:55:40 -07:00
Alexandre Gigliotti
8f27f9d04f Updated README. 2015-08-06 08:37:37 -07:00
Alexandre Gigliotti
76ff6ca703 Updated README. 2015-08-05 16:16:35 -07:00
Alexandre Gigliotti
8e3a9b0390 0.1.4 2015-08-05 16:14:58 -07:00
Alexandre Gigliotti
56a6f43657 0.1.3 2015-08-05 16:10:27 -07:00
Alexandre Gigliotti
d5c6a6b540 Updated license. 2015-08-05 16:10:21 -07:00
Alexandre Gigliotti
a126b341cc 0.1.2 2015-08-05 15:52:37 -07:00
Alexandre Gigliotti
734cd940a8 Updated README. 2015-08-05 15:52:08 -07:00
Alexandre Gigliotti
8854629943 Updated README. 2015-08-05 15:46:46 -07:00
Alexandre Gigliotti
070fc331e7 Added README and .travis files. 2015-08-05 15:36:27 -07:00
Alexandre Gigliotti
4d9eeaa926 0.1.1 2015-07-30 09:13:44 -07:00
Alexandre Gigliotti
840dba9901 Fixed bug where style attributes of elements outside a body element would not be inlined. 2015-07-30 09:13:39 -07:00
5 changed files with 117 additions and 8 deletions

4
.gitignore vendored
View File

@@ -1,2 +1,4 @@
node_modules
test/test.html
.idea
*.log
test/test.html

3
.travis.yml Normal file
View File

@@ -0,0 +1,3 @@
language: node_js
node_js:
- "node"

105
README.md Normal file
View File

@@ -0,0 +1,105 @@
# inline-html
Inline local assets referenced in an HTML document.
[![npm version](https://img.shields.io/npm/v/inline-html.svg)](https://www.npmjs.com/package/inline-html)
[![npm license](https://img.shields.io/npm/l/inline-html.svg)](https://www.npmjs.com/package/inline-html)
[![Travis](https://img.shields.io/travis/panosoft/inline-html.svg)](https://travis-ci.org/panosoft/inline-html)
[![David](https://img.shields.io/david/panosoft/inline-html.svg)](https://david-dm.org/panosoft/inline-html)
[![npm downloads](https://img.shields.io/npm/dm/inline-html.svg)](https://www.npmjs.com/package/inline-html)
## Installation
```sh
npm install inline-html
```
## Usage
Reads an HTML file, embeds the contents of local assets that are referenced within that file, and returns the inlined `html` string.
The following elements and data types are inlined:
- LESS stylesheets - The LESS is compiled and the result is inlined within a `<style>` element.
- CSS url data types - The reference path is replaced with a datauri. These can be used in linked stylesheets, style elements, and element style attributes.
- Images - The source path is replaced with a datauri.
Assuming we have the following files:
- `index.html`
```html
<link rel="stylesheet/less" href="main.less"/>
<style>
div { background-image: url('path/to/file'); }
</style>
<div style="background-image: url('path/to/file');"></div>
<img src="path/to/file"/>
```
- `main.less`
```css
@import (inline) 'main.css';
div { background-image: url('path/to/file'); }
```
- `main.css`
```css
@font-face { src: url('path/to/file'); }
```
We can use `inline-html`:
```js
var inlineHtml = require('inline-html');
inlineHtml('index.html').then(function (html) {
// ...
});
```
To create the following `html` string:
```html
<style>
@font-face { src: url('data:...'); }
div { background-image: url('data:...'); }
</style>
<style>
div { background-image: url('data:...'); }
</style>
<div style="background-image: url('data:...');"></div>
<img src="data:..."/>
```
## API
- [`inlineHtml`](#inlineHtml)
---
<a name="inlineHtml"/>
### inlineHtml ( filename [, options] )
Reads an HTML file and embeds referenced local assets into the HTML.
Returns a `Promise` that is fulfilled with an `html` string or an instance of [`Results`](#Results) depending on the value of `options.verbose`.
__Arguments__
- `filename` - The filename of the HTML file to be inlined. Relative file paths are resolved relative to the filename directory.
- `options`
- `less` - An object containing LESS options to pass to the less compiler. Defaults to `{}`.
- `verbose` - A boolean that determines the promises fulfillment value. Supported values are:
- `true`: An instance of [`Results`](#Results).
- `false`: An `html` string. (_default_)
<a name="Results"/>
__Results__
The `Promise` returned by this function is optionally fulfilled with a `results` object that has the following properties:
- `html` - The inlined html
- `files` - An array of filenames for the local assets that were inlined.

View File

@@ -14,22 +14,21 @@ var unwrap = function (value) {
var inline = function (html, filename) {
var files = [];
var $ = cheerio.load(html, {decodeEntities: false});
// style elements
var styles = $('style');
styles.each(function (index, element) {
var css = $(element).html();
result = inlineUrl(css, filename);
var result = inlineUrl(css, filename);
files.push(result.files);
$(element).html(result.css);
});
// style attributes
var attributes = $('body *').filter('[style]');
var attributes = $('*').filter('[style]');
attributes.each(function (index, element) {
var css = $(element).attr('style');
css = wrap(css);
result = inlineUrl(css, filename);
var result = inlineUrl(css, filename);
files.push(result.files);
css = string(result.css).collapseWhitespace().toString();
css = unwrap(css);

View File

@@ -1,14 +1,14 @@
{
"name": "inline-html",
"version": "0.1.0",
"description": "Inline an html file.",
"version": "0.1.6",
"description": "Inline local assets referenced in an HTML document.",
"repository": "panosoft/inline-html",
"main": "lib/index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC",
"license": "MIT",
"dependencies": {
"cheerio": "^0.19.0",
"co": "^4.6.0",