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
| Reference | Use it for |
|---|---|
| Content config | Collections, schemas, CMS metadata, providers, and agent-readable content |
| Module options | Runtime behavior in nuxt.config.ts |
| Query API | Typed document reads on the client and server |
| Composables | Route pages, search state, and client utilities |
| Server API | Nitro queries, sitemap entries, and cache helpers |
| Components | Parsed and inline Markdown rendering |
| Document envelope | Identity, route, locale, and fallback facts |
| Query operators | The public where grammar |
Extension APIs
| Reference | Use it for |
|---|---|
| Provider contract | Implementing a content source |
| Data-source adapters | Binding a CMS or remote backend through the framework-free contract |
| Package exports | Finding 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.