Examples

Run focused examples and playgrounds for pages, queries, MDC, localization, search, and agent-readable output.

Examples isolate one integration. Playgrounds exercise several features together and are better for exploration than copy-and-paste.

Focused examples

What it demonstrates	Workspace path	Run from the repository root
Route-backed pages	`examples/essentials/hello-world`	`pnpm example essentials/hello-world`
Queries across Markdown and data files	`examples/queries/querying`	`pnpm example queries/querying`
MDC components, props, slots, and nesting	`examples/mdc/components`	`pnpm example mdc/components`
A custom content transformer	`examples/advanced/transformer`	`pnpm example advanced/transformer`

Each path contains its own Nuxt configuration, content configuration, pages, and sample content.

Playgrounds

playground/ginko-basic covers pages, data collections, queries, and rendering.
playground/ginko-i18n covers locale variants, fallback, translated routes, navigation, sitemap, and agent output.
playground/ginko-search covers MiniSearch.
playground/ginko-search-i18n covers locale-scoped search.
playground/ginko-provider-search covers provider-owned search.
playground/ginko-agent-output covers localized agent Markdown, custom serializers, app-owned pages, and same-URL Markdown negotiation.
playground/ginko-agent-disabled verifies that agent routes stay unavailable when the feature is disabled.

Run the default playground:

terminal

pnpm dev

Run a specific playground from its directory:

terminal

pnpm --dir playground/ginko-i18n dev

Use a focused example when you need a small working boundary. Use a playground when behavior depends on several integrations, but copy only the files relevant to your application.

Repository maintainers verify all focused examples with:

terminal

pnpm examples:build