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

package/shared/types/app-config.ts

@@ -1,172 +0,0 @@
-export type { GinkoDocsNeutralPalette, GinkoDocsPrimaryPalette } from "../theme-palettes";
-export type { GinkoDocsThemePreset } from "../theme-presets";
-import type { GinkoDocsNeutralPalette, GinkoDocsPrimaryPalette } from "../theme-palettes";
-import type { GinkoDocsThemePreset } from "../theme-presets";
-
-export type GinkoDocsLocalizedText = string | { en: string; de?: string };
-
-export type GinkoDocsProseAppearance = "quiet" | "tint";
-export type GinkoDocsCodeBlockTheme = "dark" | "adaptive";
-export type GinkoDocsProseFamily =
-  | "callout"
-  | "aside"
-  | "excerpt"
-  | "cards"
-  | "readMore"
-  | "accordion"
-  | "tabs"
-  | "code"
-  | "files"
-  | "api"
-  | "figure"
-  | "quiz"
-  | "steps"
-  | "timeline";
-
-export interface GinkoDocsProseConfig {
-  appearance: GinkoDocsProseAppearance;
-  components?: Partial<Record<GinkoDocsProseFamily, GinkoDocsProseAppearance>>;
-}
-
-export interface GinkoDocsLink {
-  label: GinkoDocsLocalizedText;
-  to: GinkoDocsLocalizedText;
-  /** Iconify icon shown where nav items render with icons (e.g. mobile menu). */
-  icon?: string;
-  /** One-line subtitle shown under the label in the mobile menu. */
-  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. */
-  icon?: string;
-  filename?: string;
-  /** Shiki language id; derived from the filename extension when unset. */
-  language?: string;
-  code: string;
-}
-
-export type GinkoDocsHeroMedia =
-  | { type: "image"; src: string; alt: string }
-  | {
-      type: "code";
-      code: string;
-      language?: string;
-      filename?: string;
-      /** Let the code panel use otherwise empty viewport space on wide screens. */
-      layout?: "wide";
-    }
-  | {
-      type: "code-tabs";
-      tabs: GinkoDocsHeroCodeTab[];
-      /** Let the code panel use otherwise empty viewport space on wide screens. */
-      layout?: "wide";
-    };
-
-export interface GinkoDocsAppConfig {
-  theme: {
-    /** Coordinated visual system. A non-default preset owns palette and surface tokens. */
-    preset?: GinkoDocsThemePreset;
-    neutral: GinkoDocsNeutralPalette;
-    primary: GinkoDocsPrimaryPalette;
-    codeBlocks: GinkoDocsCodeBlockTheme;
-  };
-  prose: GinkoDocsProseConfig;
-  site: {
-    name: GinkoDocsLocalizedText;
-    description: GinkoDocsLocalizedText;
-    url: string;
-    /** Square product mark used for browser icons and generated social cards. */
-    icon: string;
-    logo: { light: string; dark: string };
-    docsSidebarSwitcher: "dropdown" | "list" | "tabs";
-    lupinumAttribution: boolean;
-    /** Legal and company links rendered in the footer. */
-    legalLinks: GinkoDocsLink[];
-  };
-  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;
-    /** Dismissal storage key — change it to re-show the banner after an update. */
-    id: string;
-    text?: GinkoDocsLocalizedText;
-    link?: { label?: GinkoDocsLocalizedText; to?: GinkoDocsLocalizedText };
-    showOnLanding: boolean;
-  };
-  analytics?: {
-    plausible?: {
-      /** Public site-specific ID from the Plausible pa-<id>.js script URL. */
-      scriptId?: string;
-    };
-  };
-  social: Partial<Record<GinkoDocsSocialPlatform, GinkoDocsSocialEntry>>;
-  feedback: {
-    enabled: boolean;
-  };
-  ogImage: {
-    enabled: boolean;
-    /** OgImage template component name (file in app/components/OgImage/). */
-    component: string;
-  };
-  markdownActions: {
-    chatGpt: boolean;
-    claude: boolean;
-    mcp: boolean;
-  };
-  images: {
-    /** Click-to-zoom lightbox for prose images. */
-    zoom: boolean;
-  };
-  toc: {
-    depth: 2 | 3 | 4;
-  };
-  repository?: {
-    url: string;
-    branch?: string;
-    contentDirectory?: string;
-  };
-  landing: {
-    title: GinkoDocsLocalizedText;
-    description: GinkoDocsLocalizedText;
-    primary: GinkoDocsLink;
-    secondary?: GinkoDocsLink;
-    hero?: {
-      media?: GinkoDocsHeroMedia;
-    };
-    /** Copyable install command shown under the hero CTAs. */
-    install?: { command: string };
-    features: Array<{
-      title: GinkoDocsLocalizedText;
-      description: GinkoDocsLocalizedText;
-      icon?: string;
-    }>;
-    /** Dark full-width band highlighting agent readiness. */
-    agent?: {
-      title: GinkoDocsLocalizedText;
-      description: GinkoDocsLocalizedText;
-      /** Terminal transcript; "$"-prefixed lines render as commands, "#" as comments. */
-      code: string;
-    };
-    /** Closing call to action; primary falls back to landing.primary. */
-    cta?: {
-      title: GinkoDocsLocalizedText;
-      primary?: GinkoDocsLink;
-      secondary?: GinkoDocsLink;
-    };
-  };
-}

package/shared/types/nuxt-config.ts

@@ -1,14 +0,0 @@
-import type { BundledTheme } from "shiki";
-
-export type GinkoDocsSyntaxTheme = BundledTheme;
-
-export interface GinkoDocsSyntaxHighlightingConfig {
-  themes: {
-    light: GinkoDocsSyntaxTheme;
-    dark: GinkoDocsSyntaxTheme;
-  };
-}
-
-export interface GinkoDocsNuxtConfig {
-  syntaxHighlighting?: GinkoDocsSyntaxHighlightingConfig;
-}

package/tags.ts

@@ -1,192 +0,0 @@
-import type { PortableComponentPolicyV1 } from "@lupinum/ginko-content/cms-contract";
-
-export const contentComponentTags = {
-  accordion: "MdcAccordion",
-  "accordion-item": "MdcAccordionItem",
-  api: "MdcApi",
-  aside: "MdcAside",
-  card: "MdcCard",
-  cards: "MdcCards",
-  center: "MdcCenter",
-  "code-group": "MdcCodeGroup",
-  "code-tree": "MdcCodeTree",
-  collapse: "MdcCollapse",
-  column: "MdcColumn",
-  dropcap: "MdcDropcap",
-  error: "MdcError",
-  excerpt: "MdcExcerpt",
-  figure: "MdcFigure",
-  files: "MdcFiles",
-  idea: "MdcIdea",
-  img: "ProseImg",
-  info: "MdcInfo",
-  kbd: "MdcKbd",
-  layout: "MdcLayout",
-  note: "MdcNote",
-  quiz: "MdcQuiz",
-  "quiz-question": "MdcQuizQuestion",
-  "read-more": "MdcReadMore",
-  steps: "MdcSteps",
-  success: "MdcSuccess",
-  tab: "MdcTab",
-  tabs: "MdcTabs",
-  timeline: "MdcTimeline",
-  "timeline-item": "MdcTimelineItem",
-  toc: "MdcInlineToc",
-  warning: "MdcWarning",
-} as const;
-
-type ComponentDefinition = PortableComponentPolicyV1["components"][string];
-type ComponentProps = ComponentDefinition["props"];
-
-const optional = (type: ComponentProps[string]["type"]) => ({ type, required: false });
-const required = (type: ComponentProps[string]["type"]) => ({ type, required: true });
-const block = (
-  props: ComponentProps = {},
-  slots: string[] = ["default"],
-  media: ComponentDefinition["media"] = null,
-): ComponentDefinition => ({ kind: "block", props, slots, media });
-const inline = (props: ComponentProps = {}): ComponentDefinition => ({
-  kind: "inline",
-  props,
-  slots: ["default"],
-  media: null,
-});
-
-const appearance = { appearance: optional("string") };
-const notice = block({ title: optional("string"), icon: optional("string"), ...appearance });
-
-export const contentComponentPolicy = {
-  components: {
-    accordion: block({
-      ...appearance,
-      type: optional("string"),
-      collapsible: optional("boolean"),
-      defaultValue: optional("json"),
-    }),
-    "accordion-item": block(
-      {
-        value: optional("string"),
-        title: optional("string"),
-        content: optional("string"),
-      },
-      ["default", "title", "content"],
-    ),
-    api: block({
-      ...appearance,
-      title: optional("string"),
-      icon: optional("string"),
-      method: optional("string"),
-      path: optional("string"),
-      groups: optional("json"),
-    }),
-    aside: block({ label: optional("string"), ...appearance }),
-    card: block(
-      {
-        title: optional("string"),
-        description: optional("string"),
-        footer: optional("string"),
-        to: optional("string"),
-        target: optional("string"),
-        icon: optional("string"),
-        iconColor: optional("string"),
-        img: optional("asset"),
-        showLinkIcon: optional("boolean"),
-        horizontal: optional("boolean"),
-        ...appearance,
-      },
-      ["default", "title", "description", "footer"],
-      { sourceProp: "img", altProp: null, titleProp: null, filenameProp: null },
-    ),
-    cards: block({ cols: optional("string"), ...appearance }),
-    center: block({
-      size: optional("string"),
-      max: optional("string"),
-      type: optional("string"),
-    }),
-    "code-group": block(appearance),
-    "code-tree": block({
-      ...appearance,
-      defaultValue: optional("string"),
-      expandAll: optional("boolean"),
-    }),
-    collapse: block(appearance),
-    column: block({ size: optional("string") }),
-    dropcap: block({ lines: optional("json") }),
-    error: notice,
-    excerpt: block({ label: optional("string"), source: optional("string"), ...appearance }),
-    figure: block(
-      {
-        ...appearance,
-        src: required("asset"),
-        alt: required("string"),
-        caption: optional("string"),
-        width: optional("json"),
-        height: optional("json"),
-        bleed: optional("string"),
-        aspect: optional("string"),
-        fit: optional("string"),
-        zoom: optional("json"),
-      },
-      ["default"],
-      { sourceProp: "src", altProp: "alt", titleProp: null, filenameProp: null },
-    ),
-    files: block({ active: optional("string"), annotations: optional("json"), ...appearance }),
-    idea: notice,
-    info: notice,
-    kbd: inline(),
-    layout: block({ type: optional("string") }),
-    note: notice,
-    quiz: block({
-      ...appearance,
-      title: optional("string"),
-      description: optional("string"),
-      questionLabel: optional("string"),
-      backLabel: optional("string"),
-      nextLabel: optional("string"),
-      resultsLabel: optional("string"),
-      correctSummaryLabel: optional("string"),
-      perfectLabel: optional("string"),
-      retryPrompt: optional("string"),
-      resetLabel: optional("string"),
-    }),
-    "quiz-question": block({
-      question: required("string"),
-      type: optional("string"),
-      explanation: optional("string"),
-      options: required("json"),
-      checkLabel: optional("string"),
-      correctLabel: optional("string"),
-      incorrectLabel: optional("string"),
-      resetLabel: optional("string"),
-      multipleChoiceLabel: optional("string"),
-    }),
-    "read-more": block({ title: optional("string"), links: required("json"), ...appearance }, []),
-    steps: block({ mode: optional("string"), ...appearance }),
-    success: notice,
-    tab: block({ icon: optional("string"), label: optional("string") }),
-    tabs: block({ layout: optional("string"), padded: optional("boolean"), ...appearance }),
-    timeline: block(appearance),
-    "timeline-item": block({
-      date: optional("string"),
-      label: optional("string"),
-      title: optional("string"),
-      icon: optional("string"),
-      active: optional("boolean"),
-    }),
-    toc: block(
-      {
-        title: optional("string"),
-        depth: optional("json"),
-        open: optional("json"),
-      },
-      [],
-    ),
-    warning: notice,
-  },
-} satisfies PortableComponentPolicyV1;
-
-export const contentComponentNames = Array.from(new Set(Object.values(contentComponentTags)));
-
-export type ContentComponentTag = keyof typeof contentComponentTags;
-export type ContentComponentName = (typeof contentComponentTags)[ContentComponentTag];