Public exports

Exact package entry points, runtime values, and TypeScript types published by Ginko Docs.

Ginko Docs publishes four entry points. Import only from these paths; files inside the package are implementation details.

Entry point	Public surface
`@lupinum/ginko-docs`	Nuxt layer entry used in `extends`
`@lupinum/ginko-docs/content`	`defineGinkoDocsConfig` and its TypeScript option type
`@lupinum/ginko-docs/app-config`	App-configuration types
`@lupinum/ginko-docs/components`	Built-in tag map, component policy, component names, and related types

Nuxt layer entry

Add the root export to Nuxt's extends array:

nuxt.config.ts

export default defineNuxtConfig({
  extends: ["@lupinum/ginko-docs"],
});

The entry is the layer configuration, not a collection of application composables. It installs the layer's modules, routes, layouts, components, styles, and defaults through Nuxt's layer mechanism.

Content entry

content.config.ts

import { defineGinkoDocsConfig } from "@lupinum/ginko-docs/content";
import type { GinkoDocsContentOptions } from "@lupinum/ginko-docs/content";

Export	Kind	Purpose
`defineGinkoDocsConfig`	Function	Creates the docs-only or docs-and-blog Ginko Content configuration
`GinkoDocsContentOptions`	Type	Factory input with site, locale, and blog options

The package maps TypeScript tooling to content.ts and JavaScript runtimes to the generated content.js. Consumers use the same entry point for both; do not import either source file directly.

App-config types

import type {
  GinkoDocsAppConfig,
  GinkoDocsHeroCodeTab,
  GinkoDocsHeroMedia,
  GinkoDocsLink,
  GinkoDocsLocalizedText,
  GinkoDocsNeutralPalette,
  GinkoDocsPrimaryPalette,
} from "@lupinum/ginko-docs/app-config";

This entry exports types only:

Export	Describes
`GinkoDocsLocalizedText`	A string or `{ en: string; de?: string }` localized values
`GinkoDocsNeutralPalette`	Built-in and custom neutral-palette names
`GinkoDocsPrimaryPalette`	Built-in and custom primary-palette names
`GinkoDocsLink`	Localized label and destination with optional icon and description
`GinkoDocsHeroCodeTab`	One tab in landing-page code media
`GinkoDocsHeroMedia`	Image, code, or code-tabs hero media union
`GinkoDocsAppConfig`	Complete `ginkoDocs` app-configuration shape

Layer defaults are merged through Nuxt; this entry does not export a runtime defaults object.

Component entry

nuxt.config.ts

import {
  ginkoDocsComponentNames,
  ginkoDocsComponentPolicy,
  ginkoDocsComponentTags,
} from "@lupinum/ginko-docs/components";
import type { GinkoDocsComponentName, GinkoDocsComponentTag } from "@lupinum/ginko-docs/components";

Export	Kind	Purpose
`ginkoDocsComponentTags`	Runtime object	Maps all 33 authored tag names to Vue component names
`ginkoDocsComponentPolicy`	Runtime object	Declares allowed static props, slots, component kinds, and media fields
`ginkoDocsComponentNames`	Runtime array	Unique Vue component names referenced by the tag map
`GinkoDocsComponentTag`	Type	Union of the 33 authored tag names
`GinkoDocsComponentName`	Type	Union of mapped component names

Merge ginkoDocsComponentTags when adding tags. Use ginkoDocsComponentPolicy when another integration needs the complete built-in portability contract; Nuxt already receives that policy from the layer.

Type augmentation

The package ships Nuxt schema augmentation for AppConfig.ginkoDocs and AppConfigInput.ginkoDocs. In normal Nuxt usage, defineAppConfig() receives the merged type after the layer is installed. Import GinkoDocsAppConfig explicitly only when a standalone helper or library needs the type.