Go to file
2018-04-18 05:57:25 +02:00
test Test existance of extracted stylesheets 2018-04-18 05:57:25 +02:00
.editorconfig Added some badges 2017-02-10 17:09:46 +01:00
.gitignore Added some badges 2017-02-10 17:09:46 +01:00
.travis.yml drop node 4 support 2018-03-05 21:06:59 +01:00
appveyor.yml drop node 4 support 2018-03-05 21:06:59 +01:00
cli.js minor fix 2018-03-05 21:03:35 +01:00
History.md changelog 2018-03-21 22:28:32 +01:00
index.js Support minifying extracted css (#237) 2018-04-11 20:07:13 +02:00
LICENSE Initial commit 2014-08-04 00:01:39 +02:00
package-lock.json Update lock files 2018-03-18 00:14:57 +01:00
package.json v4.0.2 2018-03-21 22:29:34 +01:00
README.md Fixes minor typos in README.md (#233) 2018-01-03 23:01:01 +01:00
yarn.lock Update lock files 2018-03-18 00:14:57 +01: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 javascript disabled will see the site rendered normally.

NPM version Build Status Build Status Dependency Status Download Coverage 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/]
});

CLI

inline-critical works well with standard input. You can either pass in the html

cat index.html | inline-critical critical.css

or just flip things around

cat critical.css | inline-critical index.html

or pass in the file as an option

inline-critical critical.css index.html

without having to worry about the correct order

inline-critical index.html critical.css

Run inline-critical --help to see the list of options.

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 (default: true)
    • 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.
    • selector defines the element used by loadCSS as a reference for inlining.

License

MIT