Skip to main content

Reference

Public configuration, query, rendering, and provider contracts for Ginko Content.

Use the reference when you know what you want to do and need an exact option, signature, or return shape. For an introduction to collection handles, canonical identity, and route projection, read How Ginko thinks.

Application APIs

ReferenceUse it for
Content configCollections, schemas, CMS metadata, providers, and agent-readable content
Module optionsRuntime behavior in nuxt.config.ts
Query APITyped document reads on the client and server
ComposablesRoute pages, search state, and client utilities
Server APINitro queries, sitemap entries, and cache helpers
ComponentsParsed and inline Markdown rendering
Document envelopeIdentity, route, locale, and fallback facts
Query operatorsThe public where grammar

Extension APIs

ReferenceUse it for
Provider contractImplementing a content source
Data-source adaptersBinding a CMS or remote backend through the framework-free contract
Package exportsFinding supported import paths and exported names

The package export map defines supported import paths. Public TypeScript declarations define signatures and result types. Provider capability constants define executable query support. These pages explain those contracts; they do not replace them.