Configuration Reference

zare.config.js

The configuration file supports .js, .mjs, .cts extensions.

For .ts, .cts, .mts, runtime TypeScript support is required.

port

The port number used when listening.

Default value: 8185

outDir

Output files directory, contains HTML and static files, see Quick Start.

Default value: "dist"

staticDir

Static files directory, or an array containing one or multiple static directories.

Default value: ["static"]

pagesDir

View files directory; Zare will build routes based on the file tree.

Default value: "pages"

alias

The “alias” is used to resolve import paths.

Similar to tsconfig.compilerOptions.paths, see TSConfig Reference .

Default value:

{
  "@/*": ["./*"]
}

generateStaticParams

The generateStaticParams function generates static parameter values for dynamic routes.

Type Declaration:

interface IZareConfig {
  generateStaticParams?: (path?: string) => Record<string, any> | Promise<Record<string, any>>;
}