mirror of
https://github.com/danog/inline-critical.git
synced 2024-11-27 04:24:39 +01:00
test | ||
vendor | ||
.editorconfig | ||
.gitignore | ||
.jshintrc | ||
.travis.yml | ||
Gruntfile.js | ||
History.md | ||
index.js | ||
LICENSE | ||
package.json | ||
README.md |
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.
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