Skip to content

vite-plugin-view

npm package

Dynamically render pages using custom template engines instead of the static index.html entry file.

NPM versionNPM DownloadsNode version


Supported Template Engines

The plugin supports 59 template engines (sorted alphabetically):

  • arc-templates
  • atpl
  • bracket
  • dot
  • dust
  • eco
  • ejs
  • ect
  • haml
  • haml-coffee
  • hamlet
  • handlebars
  • hogan
  • htmling
  • jade
  • jazz
  • jqtpl
  • just
  • liquid
  • liquor
  • lodash
  • marko
  • mote
  • mustache
  • nunjucks
  • plates
  • pug
  • qejs
  • ractive
  • razor
  • react
  • slm
  • squirrelly
  • swig
  • teacup
  • templayed
  • toffee
  • twig
  • underscore
  • vash
  • velocityjs
  • walrus
  • whiskers

Installation Steps

1. Install Plugin & Template Engine

bash
npm add vite-plugin-view <template-engine-name>
bash
pnpm add vite-plugin-view <template-engine-name>
bash
yarn add vite-plugin-view <template-engine-name>

Replace <template-engine-name> with any engine from the list above (e.g., pug or ejs).


Configuration Example

Configure the plugin in vite.config.js:

javascript
import { defineConfig } from 'vite';
import { view } from 'vite-plugin-view';

export default defineConfig({
  plugins: [
    view({
      engine: 'pug',  // Set the template engine to use (e.g., 'pug', 'ejs', etc.)
    })
  ]
});

Advanced Features

To add global variables/filters to template engines, refer to: 👉 Template Engine Instances


Important Notes

  1. Ensure the selected template engine dependency is installed (e.g., npm install pug).
  2. Place template files in Vite-accessible paths (default entry: index.${extension}).
  3. Some engines (e.g., pug) may have specific requirements for beautification (pretty option).
  4. Always test configurations with your chosen template engine.