Go to file
2015-06-09 17:20:25 +02:00
test Ignore noscript-wrapped link tags 2015-06-09 17:19:31 +02:00
vendor Use original loadCSS 2014-12-08 23:02:01 +01:00
.editorconfig implement extract options and test it out 2014-10-18 22:12:33 -03:00
.gitignore fix #6 2015-02-23 17:04:34 +01:00
.jshintrc fix jshint :) 2014-10-18 22:22:08 -03:00
.travis.yml tweakes travis 2015-02-17 01:02:59 +01:00
Gruntfile.js minor tweak 2015-02-23 17:14:14 +01:00
History.md Added History.md 2014-12-08 23:25:37 +01:00
index.js Ignore noscript-wrapped link tags 2015-06-09 17:19:31 +02:00
LICENSE Initial commit 2014-08-04 00:01:39 +02:00
package.json 0.2.0 2015-06-09 17:20:25 +02:00
README.md Ignore noscript-wrapped link tags 2015-06-09 17:19:31 +02:00

inline-critical

Inline critical-path css and load the existing stylesheets asynchronously. Existing link tags will also be wrapped in <noscript> so the users with javscript disabled will see the site rendered normally.

build status

Installation

This module is installed via npm:

$ npm install inline-critical

Example Usage

var inline = require('inline-critical');
var html = fs.readFileSync('test/fixtures/index.html', 'utf8');
var critical = fs.readFileSync('test/fixtures/critical.css', 'utf8');

var inlined = inline(html, critical);

Example Usage ignoring stylesheet per regex

var inline = require('inline-critical');
var html = fs.readFileSync('test/fixtures/index.html', 'utf8');
var critical = fs.readFileSync('test/fixtures/critical.css', 'utf8');

var inlined = inline(html, critical, {
  ignore: [/bootstrap/]
});

## inline(html, styles, options?)

- `html` is the HTML you want to use to inline your critical styles, or any other styles
- `styles` are the styles you're looking to inline
- `options` is an optional configuration object
  - `minify` will minify the styles before inlining
  - `extract` will remove the inlined styles from any stylesheets referenced in the HTML
  - `basePath` will be used when extracting styles to find the files references by `href` attributes
  - `ignore` ignore matching stylesheets when inlining.

## License

MIT