Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alwaysonlinetxm authored Oct 26, 2017
1 parent 4c9f6a3 commit a9fb7e3
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Fill the html template with the bundle js..

## Note

The 1.0.3 version has been supported to insert css file and external url, you should know that rollup-plugin-fill-html will scan the dest directory and find out the bundl js and `all the css files`, and then into the result html. So you'd better to clean the dest directory before rebuilding, and I think you may need [this](https://github.com/alwaysonlinetxm/rollup-plugin-clean) .
Rollup >= 0.48 has been supported since v1.0.6. So if you use rollup < 0.48, please choose the older version.

The 1.0.3 version has supported to insert css file and external url, you should know that rollup-plugin-fill-html will scan the dest directory and find out `all the js and css files`, and then insert these files into the result html. So you'd better to clean the dest directory before rebuilding, and I think you may need [this](https://github.com/alwaysonlinetxm/rollup-plugin-clean) .

## Installation

Expand Down Expand Up @@ -50,13 +52,18 @@ export default {

and then, you will get `bundle-a3965c0c77a63d7c74b57222e2f74028.js` in your dist directory.

## Externals

Since v1.0.3, `rollup-plugin-fill-html` has supported to include external files. You can set an `externals` option to list your files which you want to include.

## Options

You can pass an option to the `html()` just like above, and there are some options:

- template: Required. the path of the template file, it should be a html file.
- filename: Optional. the name of the result html file, if omitted, the template name will be used.
- externals: Optional. a list of files which will be insert into the resule html. The file should be a valid url.
- inject: Optional. indicate where to insert files, it can be 'head' or 'body'. For default, the css files will be inserted into `<head>` and the js files will be inserted into `<body>`.


demo:
Expand All @@ -77,6 +84,7 @@ export default {
// and you can pass a pos field to control the the position in which the file will be inserted.
// the xxxx1.js will be inserted before the bundle,
// and the xxxx2.js will be inserted after the bundle as default
// you can set an `inject` field here to cover the outer `inject`
{ type: 'js', file: '//xxxx1.js', pos: 'before' },
{ type: 'js', file: '//xxxx2.js' }
]
Expand Down

0 comments on commit a9fb7e3

Please sign in to comment.