Skip to content

VexRoutesConfig

Defined in: packages/core/src/routes/types.ts:65

Maps documents to the public paths that render them.

Omit entirely for a project with no public pages, or one whose public pages read no CMS documents. There is no sensible default: only the project knows its own URL shape.

Named for what it describes rather than for a consumer. Cache revalidation is the first consumer — resolveTargets uses map to decide which paths a write invalidated — but the same answer drives an admin “View page” link and sitemap URL generation. Live preview resolves its OWN target URL via the independent admin.livePreview.url resolver (see @vexcms/core’s livePreview module) — the two intentionally do not share a code path.

Note that this does NOT configure the ISR window. Next reads export const revalidate by static analysis before any module executes, so that value can only be an inline literal in the route file and no config here could reach it.

VexRouteMapper for the map contract

map: VexRouteMapper

Defined in: packages/core/src/routes/types.ts:70

Maps a document to the public paths that render it. Required — a routes block with no map configures nothing.