Skip to content

Valaxy API Docs

TypeDoc
优化笔记
Valaxy Docs

Sidebar Navigation

Client

Modules
- dayjs
  - Classes
    Dayjs
    Interfaces
    ConfigTypeMap
    DayjsTimezone
    FormatObject
    Type Aliases
    ConfigType
    ManipulateType
    OptionType
    OpUnitType
    PluginFunc
    QUnitType
    UnitType
    UnitTypeLong
    UnitTypeLongPlural
    UnitTypeShort
    Variables
    Ls
    tz
    Functions
    extend
    isDayjs
    locale
    unix
    utc
Interfaces
- BaseCategory
  CategoryList
  CollectionConfig
  GetHeadersOptions
  Header
  LocalSearchResult
  PostCollectionInfo
  ScrollToOptions
  ValaxySSGContext
Type Aliases
- AppContext
  AppSetup
  Categories
  Category
  MenuItem
  MermaidOptions
  MermaidSetup
  Tags
  TaxonomyNamespace
  UserModule
Variables
- cdnPrefix
  contentUpdatedCallbacks
  dataSymbol
  emptyAddonName
  EXTERNAL_URL_RE
  LOCALE_PREFIX
  name
  resolvedHeaders
  runContentUpdated
  SENSITIVE_FRONTMATTER_KEYS
  useAppStore
  useRouterStore
  useSiteStore
  valaxyConfigRef
  valaxyConfigSymbol
  valaxyContextRef
Functions
- addToParent
  asAny
  buildTree
  computeZoomRectStyle
  dayjs
  defineAppSetup
  defineClientComponent
  defineCollection
  defineMermaidSetup
  filterAndSortPosts
  formatDate
  getAddonModule
  getHeaders
  getLocaleMessageValue
  hasLocaleMessage
  initContext
  initValaxyConfig
  isCategoryList
  isEmptyAddon
  isLocaleKey
  mergeCollapsedCollections
  normalizeRepositoryUrl
  onClickHref
  onContentUpdated
  orderByMeta
  parseRangeString
  random
  removeItemFromCategory
  resolveCollectionItemHref
  resolveHeaders
  resolveSiteUrl
  resolveTaxonomyLocaleKey
  runCbs
  scrollTo
  serializeHeader
  setIframeAspectRatios
  sleep
  sortByDate
  sortByUpdated
  stripLocalePrefix
  throttleAndDebounce
  tObject
  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
  usePagination
  usePartiallyEncryptedContents
  usePostCollections
  usePostList
  usePostListWithCollections
  usePostTitle
  usePrevNext
  useRuntimeConfig
  useScreenSize
  useSidebar
  useSiteConfig
  useTags
  useValaxyApp
  useValaxyConfig
  useValaxyDark
  useValaxyHead
  useValaxyI18n
  withBase
  wrap
  wrapTable

Node

Classes
- StateManager
Interfaces
- CdnModule
  ContentCheckResult
  ContentDiagnostic
  ContentItem
  ContentLoader
  ContentLoaderContext
  ContentPageInfo
  ContentServiceOptions
  CreateCliOptions
  GroupIconOptions
  LoadConfigFromFileOptions
  MdAfterRenderContext
  ResolvedConfig
  ResolvedValaxyOptions
  ValaxyAddonCliContext
  ValaxyAddonResolver
  ValaxyEntryOptions
  ValaxyExtendConfig
  ValaxyFileInfo
  ValaxyHooks
  ValaxyNode
  ValaxyServerOptions
Type Aliases
- GroupIconValue
  HookResult
  UnoSetup
  UserInputConfig
  UserValaxyNodeConfig
  ValaxyAddonExport
  ValaxyAddonExtendCli
  ValaxyAddonFn
  ValaxyAddonLike
  ValaxyAddons
  ValaxyApp
  ValaxyConfigExport
  ValaxyConfigExtendKey
  ValaxyConfigFn
  ValaxyNodeAddon
  ValaxyNodeConfig
  ValaxyPickConfig
  ValaxyTheme
Variables
- ALL_ROUTE
  customElements
  defaultSiteConfig
  defaultValaxyConfig
  defaultViteConfig
  defineAddon
  defineConfig
  defineTheme
  desktopRuntimeVersion
  EXCERPT_SEPARATOR
  GLOBAL_STATE
  isInstalledGlobally
  mergeValaxyConfig
  PATHNAME_PROTOCOL_RE
  version
Functions
- $t
  build
  createCli
  createContentService
  createMemoryReleasePlugin
  createServer
  createValaxyNode
  defineContentLoader
  defineSiteConfig
  defineUnoSetup
  defineValaxyAddon
  defineValaxyConfig
  defineValaxyTheme
  encryptContent
  execBuild
  generateClientRedirects
  getGitTimestamp
  getServerInfoText
  isExternal
  isKatexEnabled
  isKatexPluginNeeded
  isMathJaxEnabled
  isPath
  loadConfigFromFile
  postProcessForSSG
  processValaxyOptions
  registerDevCommand
  resolveAddonsConfig
  resolveImportPath
  resolveImportUrl
  resolveOptions
  resolveSiteConfig
  resolveSiteConfigFromRoot
  resolveThemeConfigFromRoot
  resolveThemeValaxyConfig
  resolveUserThemeConfig
  resolveValaxyConfig
  resolveValaxyConfigFromRoot
  run
  ssgBuild
  startValaxyDev
  toAtFS
  transformObject
  ViteValaxyPlugins

Types

Namespaces
- DefaultTheme
  - Interfaces
    Config
Interfaces
- Album
  BaseFrontMatter
  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

Function: useCodePen()

ts

function useCodePen(): void;

1

Defined in: packages/valaxy/client/composables/widgets/codepen.ts:6

Returns

void

Deprecated

Pager

Previous pageuseCategories

Next pageuseCollapseCode