Skip to content

Valaxy API Docs

Main Navigation TypeDoc Valaxy Docs

Appearance

Sidebar Navigation

Client

Interfaces

BaseCategory

CategoryList

CollectionConfig

GetHeadersOptions

Header

ScrollToOptions

Type Aliases

AppContext

AppSetup

Categories

Category

MenuItem

MermaidOptions

MermaidSetup

Tags

UserModule

Variables

cdnPrefix

contentUpdatedCallbacks

emptyAddonName

name

resolvedHeaders

valaxyConfigRef

valaxyConfigSymbol

valaxyContextRef

Functions

addToParent

asAny

buildTree

defineAppSetup

defineCollection

defineMermaidSetup

formatDate

getHeaders

getKey

getKeyMaterial

initContext

initValaxyConfig

isCategoryList

isEmptyAddon

onClickHref

onContentUpdated

parseRangeString

random

removeItemFromCategory

resolveHeaders

runCbs

runContentUpdated

scrollTo

serializeHeader

sleep

sortByDate

throttleAndDebounce

useActiveAnchor

useAplayer

useAppStore

useBack

useBackToTop

useCategories

useCategory

useCodePen

useCollapseCode

useCollections

useConfig

useCopyCode

useData

useDecrypt

useFrontmatter

useFullUrl

useInvisibleElement

useLayout

useLocale

useMediumZoom

useMobile

useOutline

usePageList

usePagination

usePostList

usePostTitle

usePrevNext

useRouterStore

useRuntimeConfig

useScreenSize

useSidebar

useSiteConfig

useSiteStore

useTag

useTags

useValaxyConfig

useValaxyDark

useValaxyHead

wrap

wrapTable

Node

Interfaces

LoadConfigFromFileOptions

ResolvedConfig

ResolvedValaxyOptions

ValaxyAddonResolver

ValaxyEntryOptions

ValaxyExtendConfig

ValaxyHooks

ValaxyNode

ValaxyServerOptions

Type Aliases

HookResult

UnoSetup

UserInputConfig

UserValaxyNodeConfig

ValaxyAddonExport

ValaxyAddonFn

ValaxyAddonLike

ValaxyAddons

ValaxyConfigExport

ValaxyConfigExtendKey

ValaxyConfigFn

ValaxyNodeConfig

ValaxyPickConfig

ValaxyTheme

Variables

ALL_ROUTE

customElements

defaultSiteConfig

defaultValaxyConfig

defaultViteConfig

EXCERPT_SEPARATOR

EXTERNAL_URL_RE

isInstalledGlobally

PATHNAME_PROTOCOL_RE

Functions

build

cli

createServer

defineAddon

defineConfig

defineSiteConfig

defineTheme

defineUnoSetup

defineValaxyAddon

defineValaxyConfig

defineValaxyTheme

ensurePrefix

generateClientRedirects

getGitTimestamp

isExternal

isPath

loadConfig

loadConfigFromFile

mergeValaxyConfig

postProcessForSSG

processValaxyOptions

resolveAddonsConfig

resolveImportPath

resolveOptions

resolveSiteConfig

resolveSiteConfigFromRoot

resolveThemeConfigFromRoot

resolveThemeValaxyConfig

resolveUserThemeConfig

resolveValaxyConfig

resolveValaxyConfigFromRoot

run

slash

ssgBuild

toAtFS

transformObject

ViteValaxyPlugins

Types

Namespaces

DefaultTheme

Interfaces

Config

Interfaces

Album

FuseListItem

PageData

PageDataPayload

PageFrontMatter

Photo

Pkg

PostFrontMatter

RedirectItem

RedirectRule

RuntimeConfig

SiteConfig

SocialLink

ValaxyAddon

ValaxyConfig

Type Aliases

CleanUrlsMode

ExcerptType

HeadConfig

Page

PartialDeep

Post

UserSiteConfig

UserValaxyConfig

On this page

Type Alias: HookResult

HookResult: Promise<void> | void

Defined in

packages/valaxy/node/types.ts:26

Pager

Previous pageValaxyServerOptions

Next pageUnoSetup