Ox Content

types.ts

Source

HeroAction

interface

Hero section action button.

Source


HeroImage

interface

Hero section image configuration.

Source


HeroConfig

interface

Hero section configuration for entry page.

Source


FeatureConfig

interface

Feature card for entry page.

Source


EntryPageConfig

interface

Entry page frontmatter configuration.

Source


SsgOptions

interface

SSG (Static Site Generation) options.

Source


ResolvedSsgOptions

interface

Resolved SSG options.

Source


OxContentOptions

interface

Plugin options.

Source


ResolvedOptions

interface

Resolved options with all defaults applied.

Source


OgImageOptions

interface

OG image generation options.

Source


MarkdownTransformer

interface

Custom AST transformer.

Source


TransformContext

interface

Transform context passed to transformers.

Source


MarkdownNode

interface

Markdown AST node (simplified for TypeScript).

Source


TransformResult

interface

Transform result.

Source


TocEntry

interface

Table of contents entry.

Source


DocsOptions

interface

Options for source documentation generation.

Source


ResolvedDocsOptions

interface

Resolved docs options with all defaults applied.

Source


DocEntry

interface

A single documentation entry extracted from source.

Source


ParamDoc

interface

Parameter documentation.

Source


ReturnDoc

interface

Return type documentation.

Source


ExtractedDocs

interface

Extracted documentation for a single file.

Source


NavItem

interface

Navigation item for sidebar navigation.

Source


SearchOptions

interface

Options for full-text search.

Source


ResolvedSearchOptions

interface

Resolved search options.

Source


SearchDocument

interface

Search document structure.

Source


SearchResult

interface

Search result structure.

Source