@lupinum/ginko-docs 0.2.3 → 0.3.0-rc.1

package/shared/types/app-config.ts

@@ -34,6 +34,15 @@ export interface GinkoDocsLink {
   description?: GinkoDocsLocalizedText;
 }
 
+export type GinkoDocsSocialPlatform = "github" | "discord" | "linkedin";
+
+/**
+ * A URL uses the platform's built-in label and icon. Pass an object to override
+ * either — `icon` accepts any Iconify name the consuming app has registered, so
+ * sites that ship brand marks are not limited to the layer's bundled icons.
+ */
+export type GinkoDocsSocialEntry = string | { href: string; label?: string; icon?: string };
+
 export interface GinkoDocsHeroCodeTab {
   label: GinkoDocsLocalizedText;
   /** Iconify icon shown in the tab. */
@@ -49,17 +58,6 @@ export type GinkoDocsHeroMedia =
   | { type: "code"; code: string; language?: string; filename?: string }
   | { type: "code-tabs"; tabs: GinkoDocsHeroCodeTab[] };
 
-export type GinkoDocsPlausibleExtension =
-  | "hash"
-  | "outbound-links"
-  | "file-downloads"
-  | "tagged-events"
-  | "revenue"
-  | "pageview-props"
-  | "compat"
-  | "local"
-  | "manual";
-
 export interface GinkoDocsAppConfig {
   theme: {
     neutral: GinkoDocsNeutralPalette;
@@ -77,6 +75,8 @@ export interface GinkoDocsAppConfig {
   nav: {
     /** "auto" derives Docs (+ Blog when blog routes exist); an array overrides entirely. */
     links: "auto" | GinkoDocsLink[];
+    /** Render configured social links as icon buttons in the header instead of labelled rows. */
+    socialIcons: boolean;
   };
   banner: {
     enabled: boolean;
@@ -88,18 +88,11 @@ export interface GinkoDocsAppConfig {
   };
   analytics?: {
     plausible?: {
-      /** Leave unset to keep analytics fully disabled. */
-      domain?: string;
-      /** Self-hosted Plausible script URL override. */
-      scriptSrc?: string;
-      /** Plausible script extensions, e.g. ["outbound-links", "file-downloads"]. */
-      extensions?: GinkoDocsPlausibleExtension[];
+      /** Public site-specific ID from the Plausible pa-<id>.js script URL. */
+      scriptId?: string;
     };
   };
-  social: {
-    github?: string;
-    linkedin?: string;
-  };
+  social: Partial<Record<GinkoDocsSocialPlatform, GinkoDocsSocialEntry>>;
   feedback: {
     enabled: boolean;
   };