API Reference
Find configuration helpers, client composables and extension APIs. Reference pages are generated from the same source revision as this documentation; each symbol links to its source.
- Configure a site: defineConfig, defineSiteConfig
- Build a theme: theme authoring guide, client APIs
- Extend Valaxy: node APIs, shared types
Valaxy version: 1.2.2
Source revision: f5abf4d73513
313 APIs
client
Functions 119
- addToParent
- asAny
- buildTree
- computeZoomRectStyle
- dayjs
- decodePath
- defineAppSetup
- defineClientComponent
- defineCollection
- defineMermaidSetup
- extractMarkdownImage
- filterAndSortPosts
- formatDate
- getAddonDocsPath
- getAddonModule
- getHeaders
- getLocaleMessageValue
- hasLocaleMessage
- initContext
- initValaxyConfig
- isCategoryList
- isEmptyAddon
- isLocaleKey
- isReadmePage
- isSamePagePath
- isUnderscorePage
- isUnpublishedPage
- localizeAddon
- mergeCollapsedCollections
- mergePageExcludes
- normalizeAddonLocale
- normalizeExcludeGlobs
- normalizePagePath
- normalizeRepositoryUrl
- notFoundSitemapPaths
- omitProductionDraftRoutes
- onClickHref
- onContentUpdated
- openGraphType
- orderByMeta
- pageExcludeGlobs
- parseRangeString
- pickPageShareImage
- pickShareImage
- plainSeoDescription
- publicAuthor
- random
- relativePagePath
- removeItemFromCategory
- resolveCanonicalPath
- resolveCollectionItemHref
- resolveHeaders
- resolveShareImage
- resolveSiteUrl
- resolveSocialSameAs
- resolveTaxonomyLocaleKey
- runCbs
- scrollTo
- serializeHeader
- setIframeAspectRatios
- sleep
- sortByDate
- sortByUpdated
- stripEncryptedContent
- stripLocalePrefix
- svgToPng
- throttleAndDebounce
- tObject
- toZonedDayjs
- useActiveAnchor
- useAddonConfig
- useBack
- useBackToTop
- useCategories
- useCodePen
- useCollapseCode
- useCollection
- useCollectionPosts
- useCollections
- useConfig
- useCopyCode
- useCopyMarkdown
- useData
- useDecrypt
- useEncryptedContent
- useEncryptedPhotos
- useFrontmatter
- useFullUrl
- useFuseSearch
- useInvisibleElement
- useLayout
- useLocale
- useLocaleTitle
- useLocalSearch
- useMediumZoom
- useMobile
- useOutline
- usePageList
- usePageSeo
- usePagination
- usePartiallyEncryptedContents
- usePostCollections
- usePostList
- usePostListWithCollections
- usePostTitle
- usePrevNext
- useRuntimeConfig
- useScreenSize
- useSidebar
- useSiteConfig
- useTags
- useValaxyApp
- useValaxyConfig
- useValaxyDark
- useValaxyHead
- useValaxyI18n
- withBase
- wrap
- wrapTable
Variables 19
Interfaces 15
Type Aliases 10
Modules / dayjs / Classes 1
Modules / dayjs / Interfaces 3
Modules / dayjs / Type Aliases 10
Modules / dayjs / Variables 2
Modules / dayjs / Functions 5
node
Functions 45
- $t
- build
- createCli
- createContentService
- createMemoryReleasePlugin
- createServer
- createValaxyNode
- defineContentLoader
- defineSiteConfig
- defineUnoSetup
- defineValaxyAddon
- defineValaxyConfig
- defineValaxyTheme
- encryptContent
- execBuild
- generateClientRedirects
- getGitTimestamp
- getServerInfoText
- isExternal
- isKatexEnabled
- isKatexPluginNeeded
- isMathJaxEnabled
- isPath
- loadAllContent
- loadConfigFromFile
- postProcessForSSG
- processValaxyOptions
- registerDevCommand
- resolveAddonsConfig
- resolveImportPath
- resolveImportUrl
- resolveOptions
- resolveSiteConfig
- resolveSiteConfigFromRoot
- resolveThemeConfigFromRoot
- resolveThemeValaxyConfig
- resolveUserThemeConfig
- resolveValaxyConfig
- resolveValaxyConfigFromRoot
- run
- ssgBuild
- startValaxyDev
- toAtFS
- transformObject
- ViteValaxyPlugins
Variables 15
Interfaces 22
- CdnModule
- ContentCheckResult
- ContentDiagnostic
- ContentItem
- ContentLoader
- ContentLoaderContext
- ContentPageInfo
- ContentServiceOptions
- CreateCliOptions
- GroupIconOptions
- LoadConfigFromFileOptions
- MdAfterRenderContext
- ResolvedConfig
- ResolvedValaxyOptions
- ValaxyAddonCliContext
- ValaxyAddonResolver
- ValaxyEntryOptions
- ValaxyExtendConfig
- ValaxyFileInfo
- ValaxyHooks
- ValaxyNode
- ValaxyServerOptions