mirror of
https://github.com/danog/inline-critical.git
synced 2024-11-27 04:24:39 +01:00
74 lines
2.1 KiB
Markdown
74 lines
2.1 KiB
Markdown
# 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.
|
|
|
|
[](http://travis-ci.org/bezoerb/inline-critical)
|
|
|
|
## Installation
|
|
|
|
This module is installed via npm:
|
|
|
|
``` bash
|
|
$ npm install inline-critical
|
|
```
|
|
|
|
## Example Usage
|
|
|
|
``` js
|
|
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
|
|
|
|
|
|
``` js
|
|
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
|
|
```bash
|
|
cat index.html | inline-critical critical.css
|
|
```
|
|
or just flip things around
|
|
```bash
|
|
cat critical.css | inline-critical index.html
|
|
```
|
|
or pass in the fileas as an option
|
|
```bash
|
|
inline-critical critical.css index.html
|
|
```
|
|
without having to worry about the correct order
|
|
```bash
|
|
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
|
|
- `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
|