node

Source: 1.0.0-rc.14 · ecc10ae38a81 (uncommitted changes)

Classes

ClassDescription
StateManagerTransient state shared by plugins in one Valaxy build context.

Interfaces

InterfaceDescription
CdnModuleA module to load from CDN instead of bundling
ContentCheckResult-
ContentDiagnostic-
ContentItem-
ContentLoader-
ContentLoaderContext-
ContentPageInfo-
ContentServiceOptions-
CreateCliOptions-
GroupIconOptions-
LoadConfigFromFileOptions-
MdAfterRenderContext-
ResolvedConfig-
ResolvedValaxyOptions-
ValaxyAddonCliContext-
ValaxyAddonResolver-
ValaxyEntryOptions-
ValaxyExtendConfig-
ValaxyFileInfo-
ValaxyHooks-
ValaxyNode-
ValaxyServerOptions-

Type Aliases

Type AliasDescription
GroupIconValue-
HookResult-
UnoSetup-
UserInputConfig-
UserValaxyNodeConfig-
ValaxyAddonExport-
ValaxyAddonExtendCliExtend the CLI below the addon’s package-derived command namespace.
ValaxyAddonFn-
ValaxyAddonLike-
ValaxyAddons-
ValaxyApp-
ValaxyConfigExport-
ValaxyConfigExtendKey-
ValaxyConfigFnfn with options for theme config
ValaxyNodeAddon-
ValaxyNodeConfig-
ValaxyPickConfig-
ValaxyTheme-

Variables

VariableDescription
ALL_ROUTE-
customElements-
defaultSiteConfig-
defaultValaxyConfig-
defaultViteConfig-
defineAddon-
defineConfig-
defineTheme-
desktopRuntimeVersionProgrammatic lifecycle contract supported by desktop hosts.
EXCERPT_SEPARATOR-
GLOBAL_STATE-
isInstalledGlobally-
mergeValaxyConfigmerge valaxy.config (source, default)
PATHNAME_PROTOCOL_RE-
version-

Functions

FunctionDescription
[ t](/api/node/functions/ t.md)试验性
build-
createCli-
createContentServiceInspect Markdown through Valaxy’s route pipeline without starting a server. Configured route/Markdown hooks run as they do during route generation. Scans are serialized and rebuilt per request so edits and removals are observable.
createMemoryReleasePlugin-
createServer-
createValaxyNodeValaxy Node Instance
defineContentLoaderDefine a content loader for fetching content from external CMS platforms.
defineSiteConfigType helper for site.config.ts
defineUnoSetup-
defineValaxyAddon-
defineValaxyConfigType helper for valaxy.config.ts
defineValaxyTheme-
encryptContent-
execBuildvalaxy build
generateClientRedirects-
getGitTimestamp-
getServerInfoTextwith valaxyPrefix
isExternalis url external (http/https:)
isKatexEnabledWhether KaTeX is enabled (disabled when MathJax is active).
isKatexPluginNeededWhether 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.
isMathJaxEnabledWhether MathJax is enabled (takes priority over KaTeX).
isPath-
loadAllContentLoad content from all loaders and write .md files to cache directory. Uses digest-based incremental caching to skip unchanged files.
loadConfigFromFile-
postProcessForSSGShared post-processing after the SSG build.
processValaxyOptionsPost process valaxyOptions
registerDevCommand-
resolveAddonsConfig-
resolveImportPathBefore is CJS: use 'resolve' ESM: use 'mlly'
resolveImportUrlResolve path for import url on Vite client side
resolveOptions-
resolveSiteConfigresolve site.config.ts and merge with default
resolveSiteConfigFromRootresolve valaxy config from special root
resolveThemeConfigFromRootresolve theme config from special root
resolveThemeValaxyConfigresolve theme config
resolveUserThemeConfigresolve theme.config.ts and merge with default
resolveValaxyConfigresolve user valaxy config options only have userRoot
resolveValaxyConfigFromRoot-
run-
ssgBuild-
startValaxyDev-
toAtFS-
transformObjecttransform obj for vite code
ViteValaxyPlugins-