Skip to content
CtrlK

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

NameTypeRequiredDescription
deploymentBasestringYesThe 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.
projectProjectMetaYes
viteRecord<string, unknown>No
rootstringYes
contentDirstringYes
validationContentValidationConfigNoOptional for compatibility with manually constructed test/config fixtures.
openapiOpenApiConfigNo
titlestringYesSite title (used for default meta tags)
descriptionstringYesSite description (used for default meta tags)
titleSeparatorstringYesSeparator between page title and site title (default: " | ")
basestringYesBase URL path
siteUrlstringYesAbsolute site URL used for canonical and social metadata URLs
srcDirstringYesContent source directory (default: 'content')
outDirstringYesBuild output base directory, containing client/ and server/ (default: 'build')
langstringYesSite language (default: 'en')
headHeadConfig[]YesAdditional head tags (deprecated: export meta from the route or app/root.tsx instead)
markdownMarkdownConfigYesMarkdown processing options
sidebarSidebarConfigYesGenerated sidebar options
metadataMetadataConfigYesSite-level social metadata defaults
brandArdoBrandConfigYesSimple brand customization for the default theme and header logo.
seoSeoConfigYesSitemap and robots.txt generation
linkCheckLinkCheckConfigYesBuild-time internal link checking
redirectsRedirectConfig[]YesStatic redirect generation
versioningDocumentationVersioningConfig | falseYesMajor-version documentation routing.

When enabled, Ardo treats base as the deployment root and appends the current
version path to build canonical URLs, sitemap entries, and runtime links.
i18nfalse | I18nConfigYesStrict static localization. Put each localized route under
app/routes/<locale>/; Ardo rejects missing or unlocalized pages rather
than serving an implicit fallback.