node
Classes
| Class | Description |
|---|---|
| StateManager | Transient state shared by plugins in one Valaxy build context. |
Interfaces
| Interface | Description |
|---|---|
| CdnModule | A module to load from CDN instead of bundling |
| ContentItem | - |
| ContentLoader | - |
| ContentLoaderContext | - |
| CreateCliOptions | - |
| LoadConfigFromFileOptions | - |
| MdAfterRenderContext | - |
| ResolvedConfig | - |
| ResolvedValaxyOptions | - |
| ValaxyAddonCliContext | - |
| ValaxyAddonResolver | - |
| ValaxyEntryOptions | - |
| ValaxyExtendConfig | - |
| ValaxyFileInfo | - |
| ValaxyHooks | - |
| ValaxyNode | - |
| ValaxyServerOptions | - |
Type Aliases
| Type Alias | Description |
|---|---|
| HookResult | - |
| UnoSetup | - |
| UserInputConfig | - |
| UserValaxyNodeConfig | - |
| ValaxyAddonExport | - |
| ValaxyAddonExtendCli | Extend the CLI below the addon's package-derived command namespace. |
| ValaxyAddonFn | - |
| ValaxyAddonLike | - |
| ValaxyAddons | - |
| ValaxyApp | - |
| ValaxyConfigExport | - |
| ValaxyConfigExtendKey | - |
| ValaxyConfigFn | fn with options for theme config |
| ValaxyNodeAddon | - |
| ValaxyNodeConfig | - |
| ValaxyPickConfig | - |
| ValaxyTheme | - |
Variables
| Variable | Description |
|---|---|
| ALL_ROUTE | - |
| customElements | - |
| defaultSiteConfig | - |
| defaultValaxyConfig | - |
| defaultViteConfig | - |
| defineAddon | - |
| defineConfig | - |
| defineTheme | - |
| EXCERPT_SEPARATOR | - |
| GLOBAL_STATE | - |
| isInstalledGlobally | - |
| mergeValaxyConfig | merge valaxy.config (source, default) |
| PATHNAME_PROTOCOL_RE | - |
| version | - |
Functions
| Function | Description |
|---|---|
| $t | 试验性 |
| build | - |
| createCli | - |
| createMemoryReleasePlugin | - |
| createServer | - |
| defineContentLoader | Define a content loader for fetching content from external CMS platforms. |
| defineSiteConfig | Type helper for site.config.ts |
| defineUnoSetup | - |
| defineValaxyAddon | - |
| defineValaxyConfig | Type helper for valaxy.config.ts |
| defineValaxyTheme | - |
| encryptContent | - |
| generateClientRedirects | - |
| getGitTimestamp | - |
| getServerInfoText | with valaxyPrefix |
| isExternal | is url external (http/https:) |
| isKatexEnabled | Whether KaTeX is enabled (disabled when MathJax is active). |
| isKatexPluginNeeded | Whether the KaTeX markdown-it plugin should be registered. Always true unless MathJax is active, so that per-page frontmatter.katex: true can work even when features.katex is globally false. |
| isMathJaxEnabled | Whether MathJax is enabled (takes priority over KaTeX). |
| isPath | - |
| loadConfigFromFile | - |
| postProcessForSSG | Shared post-processing after the SSG build. |
| processValaxyOptions | Post process valaxyOptions |
| registerDevCommand | - |
| resolveAddonsConfig | - |
| resolveImportPath | Before is CJS: use 'resolve' ESM: use 'mlly' |
| resolveImportUrl | Resolve path for import url on Vite client side |
| resolveOptions | - |
| resolveSiteConfig | resolve site.config.ts and merge with default |
| resolveSiteConfigFromRoot | resolve valaxy config from special root |
| resolveThemeConfigFromRoot | resolve theme config from special root |
| resolveThemeValaxyConfig | resolve theme config |
| resolveUserThemeConfig | resolve theme.config.ts and merge with default |
| resolveValaxyConfig | resolve user valaxy config options only have userRoot |
| resolveValaxyConfigFromRoot | - |
| run | - |
| ssgBuild | - |
| startValaxyDev | - |
| toAtFS | - |
| transformObject | transform obj for vite code |
| ViteValaxyPlugins | - |