vite-plugin-pug weekly downloads statistics

vite-plugin-pug

A plugin that makes Vite parse in your index.html. The rendered template replaces this tag with the compiled markup.

:information_source: Vue single file components don’t require this plugin, adding Pug to the dependency list is enough. — aka npm i -D pug

Features

• [x] CommonJS and ES module builds. • [x] Handle self-closing pug tags. • [x] Works with multiple pug tags. • [x] Generated _TypeScript_ declarations. • [x] Reload when saving changes on a .pug file. • [x] Support Pug local variables. • [x] Templates for multiple inputs. • [ ] _Experimental hot module reloading functionality._ • [ ] _Handle adding or removing files._

Add to a project

Installation

Choose your appropriate choice:

Configuration

Create a vite.config.js configuration file and import the plugin:

Plugin Parameters

| Name | Required | Description |

| options | optional | Plugin options object. | | locals | optional | Data object with Pug locals. |

Plugin Options

| Name | Required | Description |

| ... | optional | Anything from Pug options object. | | localImports | optional | If true, use relative imports in the pug src attribute. |

Usage

Simple

Create a template file.

Embed pug tag with src attribute somewhere.

That's it.

:bulb: Check out its starter implementation in this repository.

Examples

Please find the examples folder in this repository.

Contribution

~~After Rollup~~ I started to use _Vite_ recently but this is not a reason to leave my beloved template format behind. Its lack of active Pug plugins made me make one quickly. It does the job to me, I will extend it when I need it. :suspect:

If it doesn't match with your setup please start a new discussion about it, I'm interested to see other workflows. If something is simply not working, please raise an issue. PRs certainly welcome! (.❛ ᴗ ❛.)

Description from the npm listing.