ResolvedConfig
On this page
import type { ResolvedConfig } from "ardo/config"
type ResolvedConfig = {
/**
* The configured deployment base before version and locale prefixes are applied.
*
* `base` is the canonical public route base used by the app runtime. Root-emitted
* files such as `robots.txt`, `sitemap.xml`, and `llms.txt` need this unversioned
* base because they are written beside the version folders.
*/
deploymentBase: string;
project: ProjectMeta;
vite?: Record<string, unknown>;
root: string;
contentDir: string;
/** Optional for compatibility with manually constructed test/config fixtures. */
validation?: ContentValidationConfig;
openapi?: OpenApiConfig;
} & Required<Omit<ArdoConfig, "buildHash" | "buildTime" | "openapi" | "project" | "validation" | "vite">>;
Properties
| Name | Type | Required | Description |
|---|---|---|---|
deploymentBase | string | Yes | The configured deployment base before version and locale prefixes are applied.base is the canonical public route base used by the app runtime. Root-emittedfiles such as robots.txt, sitemap.xml, and llms.txt need this unversionedbase because they are written beside the version folders. |
project | ProjectMeta | Yes | |
vite | Record<string, unknown> | No | |
root | string | Yes | |
contentDir | string | Yes | |
validation | ContentValidationConfig | No | Optional for compatibility with manually constructed test/config fixtures. |
openapi | OpenApiConfig | No | |
title | string | Yes | Site title (used for default meta tags) |
description | string | Yes | Site description (used for default meta tags) |
titleSeparator | string | Yes | Separator between page title and site title (default: " | ") |
base | string | Yes | Base URL path |
siteUrl | string | Yes | Absolute site URL used for canonical and social metadata URLs |
srcDir | string | Yes | Content source directory (default: 'content') |
outDir | string | Yes | Build output base directory, containing client/ and server/ (default: 'build') |
lang | string | Yes | Site language (default: 'en') |
head | HeadConfig[] | Yes | Additional head tags (deprecated: export meta from the route or app/root.tsx instead) |
markdown | MarkdownConfig | Yes | Markdown processing options |
sidebar | SidebarConfig | Yes | Generated sidebar options |
metadata | MetadataConfig | Yes | Site-level social metadata defaults |
brand | ArdoBrandConfig | Yes | Simple brand customization for the default theme and header logo. |
seo | SeoConfig | Yes | Sitemap and robots.txt generation |
linkCheck | LinkCheckConfig | Yes | Build-time internal link checking |
redirects | RedirectConfig[] | Yes | Static redirect generation |
versioning | DocumentationVersioningConfig | false | Yes | Major-version documentation routing. When enabled, Ardo treats base as the deployment root and appends the currentversion path to build canonical URLs, sitemap entries, and runtime links. |
i18n | false | I18nConfig | Yes | Strict static localization. Put each localized route underapp/routes/<locale>/; Ardo rejects missing or unlocalized pages ratherthan serving an implicit fallback. |