https://github.com/aminnairi/rollup-plugin-generate-html

Automatic HTML Generator
https://github.com/aminnairi/rollup-plugin-generate-html

Last synced: about 5 hours ago
JSON representation

Automatic HTML Generator

• Host: GitHub
• URL: https://github.com/aminnairi/rollup-plugin-generate-html
• Owner: aminnairi
• License: mit
• Created: 2018-09-14T20:42:51.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T07:14:27.000Z (almost 2 years ago)
• Last Synced: 2024-11-06T17:21:15.241Z (9 days ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@aminnairi/rollup-plugin-generate-html
• Size: 327 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rollup-plugin-generate-html

Automatic HTML Generator

## Summary

* [1. What does it do?](#1-what-does-it-do)

* [2. Installation](#2-installation)

  * [2.1 NPM](#21-npm)

  * [2.2 Yarn](#22-yarn)

* [3. Usage](#3-usage)

* [4. Example output](#4-example-output)

* [5. API](#5-api)

## 1. What does it do?

This plugin will write an `index.html` file containing all of your bundled scripts.

[Back to summary.](#summary)

## 2. Installation

### 2.1 NPM

```shell

$ npm install @aminnairi/rollup-plugin-generate-html

```

[Back to summary.](#summary)

### 2.2 Yarn

```shell

$ yarn add @aminnairi/rollup-plugin-generate-html

```

[Back to summary.](#summary)

## 3. Usage

```javascript

// rollup.config.js

import { generateHtml } from '@aminnairi/rollup-plugin-generate-html'

export default {

  input: 'src/index.js',

  output: {

    file: 'dist/index.js',

    format: 'iife'

  },

  plugins: [

    generateHtml()

  ]

}

```

[Back to summary.](#summary)

## 4. Example output

```html

  

    

    My Application

  

  

    

  

```

[Back to summary.](#summary)

## 5. API

```javascript

/**

 * @description Inject a bundle into an automatically created HTML file

 * @param {object} [configuration] The configuration object

 * @param {string} [configuration.charset=utf-8] The character set used in the meta charset tag

 * @param {string} [configuration.title=My Application] The string used in the HTML title tag

 * @param {string} [configuration.lang=en-US] The string used in the lang attribute of the html tag

 * @param {string} [configuration.path] The destination where to put the HTML file (default to rollup.output.file base directory)

 * @param {string} [configuration.publicPath] The string added before the script url

 * @param {string} [configuration.id] Will include a div with a specified id attribute, typically for JavaScript frameworks (Vue, React, ...)

 */

generateHtml({

  charset: 'ISO-8859-1',

  title: 'My Awesome Application',

  lang: 'fr-FR',

  path: '../docs',

  publicPath: '/home/',

  id: 'app'

})

```

[Back to summary.](#summary)