@beta-lib/vite-multiple-html
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

vite-multiple-html

Features

  • Multi-page application support
  • Support custom entry
  • Support custom template
  • EJS template capability (Note: This simply implements some of the functions, And multiple pages share the same injectData, You cannot set different injections for different pages)

Usage

  • create a template html
<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title><%= title %></title>
  </head>
  <body>
    <div id="app"></div>
  </body>
</html>
  • Configure in vite.config.ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import multipleHtml from '@beta-lib/vite-multiple-html';

export default defineConfig({
  base: '/prop/html',
  plugins: [
    vue(),
    multipleHtml({
        /**
         * you can add more item in packageList to set multiple pages
         */
        packageList: [{
            /**
             * you will not need to add script tags in `index.html`, the original tags need to be deleted
             */
            entry: 'src/main.ts',
            /**
             * filename is your html file's name. When you run your project, this will be your Access Name, and it will also be used as the file name of the packaged output HTML
             */
            filename: 'index',
            /**
             * templatePath is the path to the template html
             */
            templatePath: 'public.html'
        }],
        /**
         * injectData will be inject to html, Note: multiple pages share the same injectData
         */
        injectData:{
            title: '这里是注入标题'
        },
        /**
         * tempHtmlDir is used to store HTML files generated from template HTML
         * @default htmlTemp
         */
        tempHtmlDir: 'htmlTempbbbbb'
    })
  ],
})

UserOptions

Parameter Types Default Description
packageList Array<PackageItem> [] multiple pages array
injectData obj {} injectData
tempHtmlDir string htmlTemp store HTML files generated

PackageItem

Parameter Types Default Description
entry string - entry file path
filename string - Multi-page name
templatePath string - relative path to the template

dev

when you run your project in dev, you can access your vite devServer + tempHtmlDir to preview your project. such as the example above http://127.0.0.1:xxx/prop/html/htmlTempbbbbb/

build

when you build, the tempHtmlDir will be remove, you can normal access to this. such as http://127.0.0.1:xxx/prop/html/

Package Sidebar

Install

npm i @beta-lib/vite-multiple-html

Weekly Downloads

3

Version

1.0.1

License

ISC

Unpacked Size

13.2 kB

Total Files

6

Last publish

Collaborators

  • merlin_lc