@site-index/vite-plugin

@site-index/vite-plugin

Vite integration layer for site-index serve and build pipelines.

Repository README

Install

npm install -D @site-index/vite-plugin

Requirements:

• Node.js >=22
• peer dependency: vite ^8.0.10

When to use

Use this package when your project already uses Vite and you want sitemap and robots.txt artifacts handled during dev and build.

Public exports

export { siteIndexBuildPlugin } from "./domains/build/build.plugin.js";
export { siteIndexServePlugin } from "./domains/serve/serve.plugin.js";
export { siteIndexPlugin } from "./main.js";

Public API

Recommended default:

• siteIndexPlugin(options): Vite.Plugin[]

Lower-level exports:

• siteIndexBuildPlugin(options): Vite.Plugin
• siteIndexServePlugin(options): Vite.Plugin

Options:

type Options = Pick<CoreOptions, "siteUrl" | "extensions">;

Behavior

siteIndexPlugin(options) returns:

• siteIndexServePlugin(options)
• siteIndexBuildPlugin(options)

Serve plugin:

• applies in Vite dev server
• creates runtime from the existing Vite dev server
• builds artifacts during configureServer
• serves generated artifact paths such as:
  • /sitemap.xml
  • /sitemap-<name>.xml
  • /robots.txt
• returns headers only for HEAD requests
• rebuilds on hot updates when changed files are in runtime watched files
• logs warnings/errors via @site-index/observability

Build plugin:

• applies during Vite build
• creates runtime from resolved Vite config
• builds artifacts in buildStart
• emits generated artifacts as assets in generateBundle
• closes runtime in closeBundle
• logs warnings through @site-index/observability

Example

import { defineConfig } from "vite";
import { siteIndexPlugin } from "@site-index/vite-plugin";

export default defineConfig({
  plugins: [
    siteIndexPlugin({
      siteUrl: "https://example.com",
    }),
  ],
});

Related packages

• @site-index/core
• @site-index/vite-runtime
• @site-index/observability
• site-index