theme-renderer.ts

10 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

10 symbols 5 functions 3 interfaces 1 types 1 modules 11 parameters 16 members 6 returns 1 examples

Reference

fncreateTheme(config: { layouts: Record<string, ThemeComponent>; defaultLayout?: string; }): ThemeComponentCreates a theme with layout switching support.3 paramsreturns ThemeComponent1 example

Creates a theme with layout switching support.

Signature

export function createTheme(config: {
  layouts: Record<string, ThemeComponent>;
  defaultLayout?: string;
}): ThemeComponent

View source

Parameters

config { layouts: Record<string, ThemeComponent>; defaultLayout?: string }
config.layouts Record<string, ThemeComponent>
config.defaultLayout? string

optional

Returns

ThemeComponent

Examples

Example 1

import { createTheme } from '@ox-content/vite-plugin';
import { DefaultLayout } from './layouts/Default';
import { EntryLayout } from './layouts/Entry';

fnDefaultTheme({ children }: ThemeProps): JSXNodeDefault theme component. A minimal theme that renders page content with basic s…1 paramreturns JSXNode

Default theme component. A minimal theme that renders page content with basic styling.

Signature

export function DefaultTheme({ children }: ThemeProps): JSXNode

View source

Parameters

param ThemeProps

Returns

JSXNode

fngenerateTypes(pages: PageData[], outDir: string): Promise<void>Generates TypeScript type definitions from page frontmatter.2 paramsreturns Promise<void>

Generates TypeScript type definitions from page frontmatter.

Signature

export async function generateTypes(pages: PageData[], outDir: string): Promise<void>

View source

Parameters

pages PageData[]

All pages
outDir string

Output directory for types

Returns

Promise<void>

interfacePageDataPage data for rendering.9 members

Page data for rendering.

Signature

export interface PageData

View source

Members

Properties

Name	Type	Description
`description`optional	`string`	Page description
`frontmatter`	`Record<string, unknown>`	Frontmatter
`html`	`string`	Rendered HTML content
`lastUpdated`optional	`number`	Last git commit timestamp in milliseconds
`layout`optional	`string`	Layout name
`path`	`string`	Source file path
`title`	`string`	Page title
`toc`	`TocEntry[]`	Table of contents
`url`	`string`	Output URL path

fnrenderAllPages(pages: PageData[], options: ThemeRenderOptions): Promise<Map<string, string>>Renders all pages and generates type definitions.2 paramsreturns Promise<Map<string, string>>

Renders all pages and generates type definitions.

Signature

export async function renderAllPages(pages: PageData[], options: ThemeRenderOptions): Promise<Map<string, string>>

View source

Parameters

pages PageData[]

All pages to render
options ThemeRenderOptions

Theme render options

Returns

Promise<Map<string, string>>

Map of output paths to rendered HTML

fnrenderPage(page: PageData, options: ThemeRenderOptions): stringRenders a page using the theme component.2 paramsreturns string

Renders a page using the theme component.

Signature

export function renderPage(page: PageData, options: ThemeRenderOptions): string

View source

Parameters

page PageData

Page data to render
options ThemeRenderOptions

Theme render options

Returns

string

Rendered HTML string

moduletheme-rendererTheme Renderer for Static HTML Generation Renders JSX theme components to static HTML strings. No client-side JavaScrip…

Theme Renderer for Static HTML Generation

Renders JSX theme components to static HTML strings. No client-side JavaScript is included by default.

View source

typeThemeComponent = (props: ThemeProps) => JSXNodeTheme component type.1 paramreturns JSXNode

Theme component type.

Signature

export type ThemeComponent = (props: ThemeProps) => JSXNode

View source

Parameters

props ThemeProps

Returns

JSXNode

interfaceThemePropsProps passed to the theme component.1 member

Props passed to the theme component.

Signature

export interface ThemeProps

View source

Members

Properties

Name	Type	Description
`children`	`JSXNode`	Rendered page content as JSX

interfaceThemeRenderOptionsTheme render options.6 members

Theme render options.

Signature

export interface ThemeRenderOptions

View source

Members

Properties

Name	Type	Description
`base`	`string`	Base URL path
`nav`	`NavGroup[]`	Navigation groups
`pages`	`PageData[]`	All pages (for site context)
`siteName`	`string`	Site name
`theme`	`ThemeComponent`	Theme component to use `props`
`typesOutDir`optional	`string`	Output directory for type definitions