@lupinum/ginko-docs 0.4.0-rc.9 → 0.5.0

package/app/app.config.ts

@@ -1,55 +1,44 @@
-import type { GinkoDocsAppConfig } from "../shared/types/app-config";
-export default {
-  ginkoDocs: {
-    theme: {
-      preset: "default",
-      neutral: "zinc",
-      primary: "neutral",
-      codeBlocks: "dark",
-    },
-    prose: {
-      appearance: "tint",
-    },
-    site: {
-      name: { en: "Ginko Docs", de: "Ginko Docs" },
-      description: {
-        en: "Documentation sites built with Nuxt and Ginko Content.",
-        de: "Dokumentations-Sites auf Basis von Nuxt und Ginko Content.",
-      },
-      url: "http://localhost:3000",
-      icon: "/favicon.svg",
-      logo: { light: "/logo.svg", dark: "/logo-dark.svg" },
-      docsSidebarSwitcher: "tabs",
-      lupinumAttribution: true,
-      legalLinks: [],
-    },
-    nav: { links: "auto", socialIcons: false },
-    banner: {
-      enabled: false,
-      id: "default",
-      showOnLanding: true,
-    },
-    social: {},
-    feedback: { enabled: false },
-    ogImage: { enabled: true, component: "GinkoDocs" },
-    markdownActions: { chatGpt: true, claude: true, mcp: true },
-    images: { zoom: true },
-    toc: { depth: 3 },
-    repository: undefined,
-    landing: {
-      title: {
-        en: "Publish structured documentation.",
-        de: "Veröffentliche strukturierte Dokumentation.",
-      },
-      description: {
-        en: "A Nuxt layer for searchable, localized documentation with stable routes and agent-readable output.",
-        de: "Ein Nuxt-Layer für durchsuchbare, lokalisierte Dokumentation mit stabilen Routen und agentenlesbarer Ausgabe.",
-      },
-      primary: {
-        label: { en: "Get started", de: "Erste Schritte" },
-        to: { en: "/docs", de: "/de/dokumentation" },
-      },
-      features: [],
-    },
-  } satisfies GinkoDocsAppConfig,
-};
+// The site sets its docs options in its own app.config.ts; every option is optional:
+//   export default defineAppConfig({ docs: { title: 'Ginko', logo: { light: '/logo.svg' }, social: [...] } })
+// Texts are not configured here but in the site's i18n messages (see the README).
+import type { DocsAssistant } from './lib/docsPage'
+
+export default defineAppConfig({ docs: {} })
+
+export interface DocsConfig {
+  /** Brand name in the header; the accessible name of the logo. Default: `name` from ginko.config.ts. */
+  title?: string
+  /** A logo before the title, or instead of it with `wordmark: true` (the image then carries the name).
+   *  `dark` is shown in dark mode (else `light` always). */
+  logo?: { light: string, dark?: string, wordmark?: boolean }
+  /** Colour preset: `default` (emerald on zinc) or `green` (green on slate). A site's own shadcn tokens win over either. */
+  theme?: 'default' | 'green'
+  /** More header links after Docs, Blog and Changelog. Texts: messages `docs.nav.<id>`. */
+  nav?: { id: string, href: string }[]
+  /** Icon links at the end of the header, e.g. `{ icon: 'docs:github', href, label: 'GitHub' }`. Built in:
+   *  `docs:github`, `docs:discord`, `docs:x`, `docs:bluesky`, `docs:mastodon`, `docs:linkedin`, `docs:youtube`. */
+  social?: { icon: string, href: string, label: string }[]
+  /** Dismissible banner above the header. Text: message `docs.banner.<id>`. A new id shows it again to everyone. */
+  banner?: { id: string, href?: string }
+  /** Git host of the docs: "Edit this page" for pages from files, "Report an issue" for GitHub repositories. */
+  repository?: {
+    url: string
+    /** Default `main`. */
+    branch?: string
+    /** Edit link template; `{url}`, `{branch}` and `{source}` are replaced. Default `{url}/edit/{branch}/{source}`. */
+    editUrl?: string
+    /** Issue link template; `{url}`, `{title}` and `{page}` are replaced. Default on GitHub: a new issue with the page title. */
+    issueUrl?: string
+  }
+  /** "Copy page" (default true) and the chats the page menu can open it in (default both, `[]` for none). */
+  markdownActions?: { copy?: boolean, openIn?: DocsAssistant[] }
+  /** `false` leaves out the built-in search (header, sidebar, phone bar), for a site with <DocsSearch /> in its own header. */
+  search?: boolean
+  /** Footer. Link texts: messages `docs.footer.<id>`. `attribution` (default true) adds "Built with Ginko". */
+  footer?: { links?: { id: string, href: string }[], attribution?: boolean }
+}
+
+declare module '@nuxt/schema' {
+  interface AppConfigInput { docs?: DocsConfig }
+  interface AppConfig { docs: DocsConfig }
+}