Go to file
2019-11-12 23:15:12 +01:00
.github/workflows Switch to GitHub Actions CI 2019-10-24 14:33:21 +03:00
test Minor ES6 tweaks 2019-11-11 19:46:17 +02:00
.editorconfig Added some badges 2017-02-10 17:09:46 +01:00
.gitattributes Enforce LF. 2019-08-13 15:41:33 +03:00
.gitignore fix: adjusts filenames for extracted css 2019-08-13 23:59:02 +02:00
cli.js Remove os.EOL. 2019-11-11 19:54:19 +02:00
History.md Bump dependencies 2018-09-15 23:16:53 +02:00
index.js Minor ES6 tweaks 2019-11-11 19:46:17 +02:00
LICENSE Initial commit 2014-08-04 00:01:39 +02:00
package-lock.json 4.1.2 2019-11-12 23:15:12 +01:00
package.json 4.1.2 2019-11-12 23:15:12 +01:00
README.md Switch to GitHub Actions CI 2019-10-24 14:33:21 +03: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 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