API Reference
Auto-generated API documentation.
Components
- ApiHierarchy
- ApiItem
- ApiKindBadge
- ApiParametersTable
- ApiReturns
- ApiSignature
- CodeBlock
- CodeGroup
- Container
- Content
- CopyButton
- Danger
- DocLayout
- DocPage
- FeatureCard
- Features
- Footer
- Header
- Hero
- HomePage
- Info
- Layout
- Note
- PressProvider
- Search
- Sidebar
- Tab
- TabList
- TabPanel
- TabPanels
- Tabs
- ThemeToggle
- Tip
- TOC
- Warning
Functions
- config/index - defineConfig, loadConfig, resolveConfig
- markdown/pipeline - transformMarkdown, transformMarkdownToReact
- runtime/hooks - useConfig, usePageData, usePressContext, useSidebar, useTOC, useThemeConfig
- runtime/loader - getPageDataForRoute, getSlugFromPath, loadAllDocs, loadDoc
- runtime/sidebar - generateSidebar
- runtime/sidebar-utils - findCurrentSidebarItem, getPrevNextLinks
- typedoc/generator - generateApiDocs
- typedoc/vite-plugin - createTypedocWatcher, typedocPlugin
- vite/plugin - ardoPlugin
Type Aliases
- components/Container - ContainerType
- typedoc/types - ApiDocKind
Interfaces
- ApiDocHierarchy
- ApiDocItem
- ApiDocParameter
- ApiDocReturn
- ApiDocSource
- ApiDocTag
- ApiDocTypeParameter
- ArdoPluginOptions
- CodeBlockProps
- CodeGroupProps
- ContainerProps
- DangerProps
- FeatureCardProps
- FeatureItem
- FeaturesProps
- GeneratedApiDoc
- HeadConfig
- HeroAction
- HeroImage
- HeroProps
- InfoProps
- MarkdownConfig
- NavItem
- NoteProps
- PageData
- PageFrontmatter
- PressConfig - Main Ardo configuration.
- ResolvedConfig
- SidebarItem
- SocialLink
- TabListProps
- TabPanelProps
- TabPanelsProps
- TabProps
- TabsProps
- ThemeConfig - Theme configuration for backwards compatibility with config-driven approach.
- TipProps
- TOCItem
- TypeDocConfig
- TypeDocPluginOptions
- WarningProps