Öffentliche Exporte

Exakte Paket-Einstiegspunkte, Laufzeitwerte und TypeScript-Typen von Ginko Docs.

Ginko Docs veröffentlicht vier Einstiegspunkte. Importiere ausschließlich aus diesen Pfaden; Dateien innerhalb des Pakets sind Implementierungsdetails.

Einstiegspunkt	Öffentliche Oberfläche
`@lupinum/ginko-docs`	Nuxt-Layer-Einstieg für `extends`
`@lupinum/ginko-docs/content`	`defineGinkoDocsConfig` und der TypeScript-Optionstyp
`@lupinum/ginko-docs/app-config`	App-Konfigurationstypen
`@lupinum/ginko-docs/components`	Eingebaute Tag-Map, Komponenten-Policy, Komponentennamen und zugehörige Typen

Nuxt-Layer-Einstieg

Ergänze den Root-Export in Nuxt unter extends:

nuxt.config.ts

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

Der Einstieg ist die Layer-Konfiguration und keine Sammlung von Anwendungs-Composables. Über Nuxt Layers installiert er Module, Routen, Layouts, Komponenten, Styles und Standards.

Content-Einstieg

content.config.ts

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

Export	Art	Zweck
`defineGinkoDocsConfig`	Funktion	Erstellt die Ginko-Content-Konfiguration für Docs mit optionalem Blog
`GinkoDocsContentOptions`	Typ	Factory-Eingabe für Website, Sprachen und Blog

Das Paket ordnet TypeScript-Werkzeuge content.ts und JavaScript-Laufzeiten der generierten content.js zu. Consumer verwenden für beide denselben Einstiegspunkt und importieren die Quelldateien nicht direkt.

App-Config-Typen

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

Dieser Einstieg exportiert ausschließlich Typen:

Export	Beschreibung
`GinkoDocsLocalizedText`	Ein String oder lokalisierte Werte als `{ en: string; de?: string }`
`GinkoDocsNeutralPalette`	Namen integrierter und eigener Neutralpaletten
`GinkoDocsPrimaryPalette`	Namen integrierter und eigener Primärpaletten
`GinkoDocsLink`	Lokalisiertes Label und Ziel mit optionalem Icon und Beschreibung
`GinkoDocsHeroCodeTab`	Ein Tab in Code-Medien der Landing Page
`GinkoDocsHeroMedia`	Union für Bild-, Code- und Code-Tab-Medien
`GinkoDocsAppConfig`	Vollständige Form der `ginkoDocs`-App-Konfiguration

Layer-Standards werden durch Nuxt zusammengeführt. Dieser Einstieg exportiert kein Defaults-Objekt zur Laufzeit.

Komponenten-Einstieg

nuxt.config.ts

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

Export	Art	Zweck
`ginkoDocsComponentTags`	Laufzeitobjekt	Ordnet alle 33 verfassten Tag-Namen Vue-Komponentennamen zu
`ginkoDocsComponentPolicy`	Laufzeitobjekt	Deklariert erlaubte statische Props, Slots, Komponentenarten und Medienfelder
`ginkoDocsComponentNames`	Laufzeitarray	Eindeutige Vue-Komponentennamen aus der Tag-Map
`GinkoDocsComponentTag`	Typ	Union der 33 verfassten Tag-Namen
`GinkoDocsComponentName`	Typ	Union der zugeordneten Komponentennamen

Führe ginkoDocsComponentTags beim Ergänzen eigener Tags zusammen. Verwende ginkoDocsComponentPolicy, wenn eine andere Integration den vollständigen eingebauten Portabilitätsvertrag benötigt; Nuxt erhält diese Policy bereits aus dem Layer.

Type-Augmentation

Das Paket liefert Nuxt-Schema-Augmentation für AppConfig.ginkoDocs und AppConfigInput.ginkoDocs. In einer normalen Nuxt-Anwendung erhält defineAppConfig() nach der Layer-Installation den zusammengeführten Typ. Importiere GinkoDocsAppConfig nur explizit, wenn ein eigenständiger Helper oder eine Bibliothek den Typ benötigt.