Skip to content

defaultPlugin

reference
1 min readUpdated

Kind: Function

Source: src/helper/ssg/plugins.ts

Part of: Helper

The default plugin that defines the recommended behavior.

defaultPlugin creates the plugin that applies the project's recommended static-site-generation behavior. Add it to the SSG plugin list so its hooks participate in the build lifecycle.

Signature

ts
function defaultPlugin(): SSGPlugin

Returns: SSGPlugin

Diagram

mermaid
graph LR
  Config[SSG configuration] --> PluginFactory[defaultPlugin()]
  PluginFactory --> Plugin[Default plugin]
  Plugin --> Build[SSG build lifecycle]
  Build --> Output[Generated site output]

Usage

ts
import { defaultPlugin } from './src/helper/ssg/plugins';

const plugins = [
  defaultPlugin(),
];

export { plugins };

AI Coding Instructions

  • Keep defaultPlugin() in the SSG plugin configuration so the default build behavior remains active.
  • Follow the plugin hook and return-value conventions already used in src/helper/ssg/plugins.ts.
  • Avoid duplicating behavior implemented by the default plugin in custom plugins.
  • When changing plugin behavior, verify how the change affects generated static output and build-time hooks.

Relationships

  • IMPORTS → html

Used by

1 reference from 1 file. Each is a place in this repository where the symbol is actually used — go read one rather than trusting an example.

Imported by (1)

  • DEFAULT_OUTPUT_DIRsrc/helper/ssg/ssg.ts:27

Was this page helpful?

Download as PDF
defaultPlugin — Hono (narrator proof)