Skip to content

Interface: ResolvedValaxyOptions<ThemeConfig>

Defined in: packages/valaxy/node/types/options.ts:19

Type Parameters

ThemeConfig

ThemeConfig = Config

Properties

addonRoots

ts
addonRoots: string[];

Defined in: packages/valaxy/node/types/options.ts:47

Addon root path


addons

ts
addons: ValaxyAddonResolver[];

Defined in: packages/valaxy/node/types/options.ts:73

all addons Record<package-name, OptionResolver>


clientRoot

ts
clientRoot: string;

Defined in: packages/valaxy/node/types/options.ts:34

Client root path

Default

ts
'valaxy/client'

config

ts
config: ValaxyConfig<ThemeConfig> & ValaxyExtendConfig & object;

Defined in: packages/valaxy/node/types/options.ts:56

Valaxy Config

Type Declaration

runtimeConfig
ts
runtimeConfig: RuntimeConfig;

Generated Runtime Config


configFile

ts
configFile: string;

Defined in: packages/valaxy/node/types/options.ts:65

config file path


env

ts
env: MarkdownEnv & object;

Defined in: packages/valaxy/node/types/options.ts:79

Type Declaration

ts
links: string[];

mode

ts
mode: "dev" | "build";

Defined in: packages/valaxy/node/types/options.ts:20


pages

ts
pages: string[];

Defined in: packages/valaxy/node/types/options.ts:68


pkgRoot

ts
pkgRoot: string;

Defined in: packages/valaxy/node/types/options.ts:24

package.json root


redirects

ts
redirects: RedirectItem[];

Defined in: packages/valaxy/node/types/options.ts:77

Collect redirect rule


roots

ts
roots: string[];

Defined in: packages/valaxy/node/types/options.ts:51

clientRoot, themeRoot, ...addonRoots, userRoot


siteConfigFile

ts
siteConfigFile: string;

Defined in: packages/valaxy/node/types/options.ts:66


tempDir

ts
tempDir: string;

Defined in: packages/valaxy/node/types/options.ts:29

temp dir, store d.ts and other temp files .valaxy


theme

ts
theme: string;

Defined in: packages/valaxy/node/types/options.ts:52


themeConfigFile

ts
themeConfigFile: string;

Defined in: packages/valaxy/node/types/options.ts:67


themeRoot

ts
themeRoot: string;

Defined in: packages/valaxy/node/types/options.ts:43

Theme root path


userRoot

ts
userRoot: string;

Defined in: packages/valaxy/node/types/options.ts:39

User root path

Default

ts
process.cwd()