Ardo

Interface: ArdoPluginOptions

Properties

title

optional

title: string

Site title (used for default meta tags)

description

optional

description: string

Site description (used for default meta tags)

base

optional

base: string

Base URL path

srcDir

optional

srcDir: string

Content source directory (default: 'content')

outDir

optional

outDir: string

Build output directory (default: 'dist')

lang

optional

lang: string

Site language (default: 'en')

head

optional

head: HeadConfig[]

Additional head tags (deprecated: use React Router Meta instead)

themeConfig

optional

themeConfig: ThemeConfig

Theme configuration for backwards compatibility. Prefer using JSX components with props instead.

markdown

optional

markdown: MarkdownConfig

Markdown processing options

typedoc

optional

typedoc: true | TypeDocConfig

TypeDoc API documentation generation.

  • true: Enable with defaults (./src/index.ts → content/api-reference/)
  • { ... }: Enable with custom config

vite

optional

vite: Record<string, unknown>

Custom Vite configuration

routes

optional

routes: false | ArdoRoutesPluginOptions

Options for the routes generator plugin

githubPages

optional

githubPages: boolean

Auto-detect GitHub repository and set base path for GitHub Pages. When true, automatically sets base: '/repo-name/' if deploying to GitHub Pages.

routesDir

optional

routesDir: string

Directory where routes are located.

Source

vite/plugin.ts

← ApiDocTypeParameter | CodeBlockProps →