@macropygia/vite-plugin-pug-static

English | 日本語

Vite plugin to serve multiple Pug as HTML with middleware and build to static HTML.

• This package is currently unstable.
  • Breaking changes may occur without any notice, even if in patch releases.
  • See CHANGELOG for changes.
• This package only works as ESM.
  • "type": "module" is required in the package.json of the project using this plugin.
• Suitable for a traditional static site.
• Currently, full-reload is always triggered when any file is modified.
  • Compilation is triggered only when necessary.

Usage

// vite.config.js
import { defineConfig } from 'vite'
import vitePluginPugStatic from '@macropygia/vite-plugin-pug-static'

export default defineConfig({
  root: 'src',
  build: {
    rollupOptions: {
      input: {
        home: 'src/index.pug',
        foo: 'src/foo/index.pug',
        bar: 'src/bar/index.pug',
      }
    }
  },
  plugins: [
    vitePluginPugStatic({
      buildOptions: { basedir: "./src" },
      serveOptions: { basedir: "./src" },
    }),
  ],
})

Options

| Parameter | Type | Default | Required | | --------------- | -------------------- | ------- | -------- | | buildOptions | object | | No | | buildLocals | object | | No | | serveOptions | object | | No | | serverLocals | object | | No | | ignorePattern | string \| string[] | | No | | reload | boolean | true | No |

buildOptions

• Pug options for build.
• Ref. Options - Pug

buildLocals

• The locals object of pug for build.
• Ref. API Reference - Pug

serveOptions

• Pug options for dev server.
• Ref. Options - Pug

serveLocals

• The locals object of pug for dev server.
• Ref. API Reference - Pug

ignorePattern

• Ignore pattern for dev server.
• Use root-relative path. (Starts with / )
• Ref. Globbing features - Picomatch
• Compatible with vite-plugin-inspect by default.

reload

• Enable/disable full-reload when any file is modified.