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

package/app/composables/useGinkoOgImage.ts

@@ -1,20 +0,0 @@
-import { defineOgImage } from "#imports";
-import { useGinkoDocsConfig } from "./useGinkoDocsConfig";
-
-export interface GinkoOgImageProps {
-  title?: string;
-  description?: string;
-  locale?: string;
-  [key: string]: unknown;
-}
-
-/**
- * Declares the page's social image using the configured OgImage template.
- * No-op when the consumer sets `ginkoDocs.ogImage.enabled: false`.
- */
-export function useGinkoOgImage(props?: GinkoOgImageProps) {
-  const config = useGinkoDocsConfig();
-  if (config.ogImage?.enabled === false) return;
-  const component = config.ogImage?.component ?? "GinkoDocs";
-  defineOgImage(component as never, props as never);
-}

package/app/composables/useLocalizedPath.ts

@@ -1,12 +0,0 @@
-import { useI18n } from "#imports";
-import { isLocaleCode, localizedPath } from "../../i18n/locales";
-import type { LocalizedRouteKey } from "../../i18n/routes";
-
-export function useLocalizedPath() {
-  const { locale, t } = useI18n();
-
-  return (key: LocalizedRouteKey) => {
-    const path = t(`routes.${key}`);
-    return isLocaleCode(locale.value) ? localizedPath(locale.value, path) : path;
-  };
-}

package/app/composables/useLocalizedRouteSwitch.ts

@@ -1,31 +0,0 @@
-import { useRoute, useSwitchLocalePath } from "#imports";
-import type { RouteLocationRaw } from "vue-router";
-import { useContentRouteAlternates } from "./useContentRouteAlternates";
-import { isLocaleCode } from "../../i18n/locales";
-
-export function useLocalizedRouteSwitch() {
-  const route = useRoute();
-  const switchLocalePath = useSwitchLocalePath();
-  const { current: alternates } = useContentRouteAlternates();
-
-  function switchPathname(targetLocale: string) {
-    if (!isLocaleCode(targetLocale)) {
-      return route.path;
-    }
-
-    const configuredLocale = targetLocale as Parameters<typeof switchLocalePath>[0];
-    return (
-      alternates.value.find((alternate) => alternate.locale === targetLocale)?.path ||
-      switchLocalePath(configuredLocale)
-    );
-  }
-
-  function switchPath(targetLocale: string): RouteLocationRaw {
-    return { path: switchPathname(targetLocale), query: route.query, hash: route.hash };
-  }
-
-  return {
-    switchPath,
-    switchPathname,
-  };
-}

package/app/composables/useMetaKey.ts

@@ -1,18 +0,0 @@
-import { onMounted, ref, type Ref } from "vue";
-
-/**
- * Platform-aware modifier key label. Defaults to "Ctrl" during SSR and
- * upgrades to "⌘" on Apple platforms after mount (onMounted is client-only,
- * so hydration stays consistent).
- */
-export function useMetaKey(): Ref<string> {
-  const metaSymbol = ref("Ctrl");
-
-  onMounted(() => {
-    if (typeof navigator !== "undefined" && navigator.userAgent.includes("Macintosh")) {
-      metaSymbol.value = "⌘";
-    }
-  });
-
-  return metaSymbol;
-}

package/app/composables/usePageMarkdownActions.ts

@@ -1,79 +0,0 @@
-import { agentRawPathForRoute } from "@lupinum/ginko-content/agent-paths";
-import { useClipboard } from "@vueuse/core";
-import { computed, onBeforeUnmount, ref } from "vue";
-import { useRoute } from "#imports";
-import { useGinkoDocsConfig } from "./useGinkoDocsConfig";
-
-export type PageMarkdownAction = "markdown" | "link" | "mcp";
-export type PageMarkdownActionResult = "success" | "error";
-
-export function usePageMarkdownActions() {
-  const route = useRoute();
-  const config = useGinkoDocsConfig();
-  const { copy } = useClipboard({ legacy: true });
-  const result = ref<{ action: PageMarkdownAction; status: PageMarkdownActionResult } | null>(null);
-  let resetTimer: ReturnType<typeof setTimeout> | undefined;
-
-  const rawPath = computed(() => agentRawPathForRoute(route.path));
-  const rawUrl = computed(() => new URL(rawPath.value, config.site.url).toString());
-  const mcpUrl = computed(() => new URL("/mcp", config.site.url).toString());
-  const chatGptUrl = computed(
-    () =>
-      `https://chatgpt.com/?hints=search&q=${encodeURIComponent(`Read ${rawUrl.value} so I can ask questions about it.`)}`,
-  );
-  const claudeUrl = computed(
-    () =>
-      `https://claude.ai/new?q=${encodeURIComponent(`Read ${rawUrl.value} so I can ask questions about it.`)}`,
-  );
-  const actions = computed(() => ({
-    chatGpt: config.markdownActions?.chatGpt !== false,
-    claude: config.markdownActions?.claude !== false,
-    mcp: config.markdownActions?.mcp !== false,
-  }));
-
-  function setResult(action: PageMarkdownAction, status: PageMarkdownActionResult) {
-    if (resetTimer) clearTimeout(resetTimer);
-    result.value = { action, status };
-    resetTimer = setTimeout(
-      () => {
-        result.value = null;
-      },
-      status === "success" ? 1800 : 4000,
-    );
-  }
-
-  async function run(action: PageMarkdownAction, operation: () => Promise<void>) {
-    try {
-      await operation();
-      setResult(action, "success");
-    } catch {
-      setResult(action, "error");
-    }
-  }
-
-  const copyValue = (value: string, action: Exclude<PageMarkdownAction, "markdown">) =>
-    run(action, () => copy(value));
-
-  const copyMarkdown = () =>
-    run("markdown", async () => {
-      const response = await fetch(rawPath.value);
-      if (!response.ok) throw new Error(`Markdown request failed with ${response.status}`);
-      await copy(await response.text());
-    });
-
-  onBeforeUnmount(() => {
-    if (resetTimer) clearTimeout(resetTimer);
-  });
-
-  return {
-    actions,
-    chatGptUrl,
-    claudeUrl,
-    copyMarkdown,
-    copyValue,
-    mcpUrl,
-    rawPath,
-    rawUrl,
-    result,
-  };
-}

package/app/composables/useProseAppearance.ts

@@ -1,24 +0,0 @@
-import { computed, type MaybeRefOrGetter, toValue } from "vue";
-import type { GinkoDocsProseAppearance, GinkoDocsProseFamily } from "../../shared/types/app-config";
-import { useGinkoDocsConfig } from "./useGinkoDocsConfig";
-
-const DEFAULT_APPEARANCE: GinkoDocsProseAppearance = "quiet";
-
-function normalizeAppearance(value: unknown): GinkoDocsProseAppearance | undefined {
-  return value === "quiet" || value === "tint" ? value : undefined;
-}
-
-export function useProseAppearance(
-  family: GinkoDocsProseFamily,
-  appearance?: MaybeRefOrGetter<string | undefined>,
-) {
-  const config = useGinkoDocsConfig();
-
-  return computed<GinkoDocsProseAppearance>(
-    () =>
-      normalizeAppearance(toValue(appearance)) ??
-      normalizeAppearance(config.prose?.components?.[family]) ??
-      normalizeAppearance(config.prose?.appearance) ??
-      DEFAULT_APPEARANCE,
-  );
-}

package/app/composables/useSchemaJsonLd.ts

@@ -1,25 +0,0 @@
-import { toValue, type MaybeRefOrGetter } from "vue";
-import { useHead } from "#imports";
-
-export type SchemaJsonNode = Record<string, unknown>;
-
-export function useSchemaJsonLd(schemas: MaybeRefOrGetter<SchemaJsonNode[]>) {
-  useHead(() => {
-    const graph = toValue(schemas).filter(Boolean);
-
-    return {
-      script: graph.length
-        ? [
-            {
-              type: "application/ld+json",
-              "data-schema-org": "true",
-              innerHTML: JSON.stringify({
-                "@context": "https://schema.org",
-                "@graph": graph,
-              }),
-            },
-          ]
-        : [],
-    };
-  });
-}

package/app/composables/useSiteNavigation.ts

@@ -1,64 +0,0 @@
-import { getLocalizedSiteText } from "#ginko-docs/config/site.utils";
-import { useI18n, useRouter } from "#imports";
-import { useLocalizedPath } from "#ginko-docs/composables/useLocalizedPath";
-import { computed } from "vue";
-import { useGinkoDocsConfig } from "./useGinkoDocsConfig";
-import {
-  resolveBanner,
-  resolveMainNav,
-  resolveSocialLinks,
-  type NavItem,
-} from "./site-navigation.utils";
-
-export const useSiteNavigation = () => {
-  const config = useGinkoDocsConfig();
-  const { locale, t } = useI18n();
-  const router = useRouter();
-  const path = useLocalizedPath();
-
-  const site = computed(() => ({
-    name: getLocalizedSiteText(config.site.name, locale.value),
-    description: getLocalizedSiteText(config.site.description, locale.value),
-    logo: config.site.logo,
-    url: config.site.url,
-    lupinumAttribution: config.site.lupinumAttribution,
-    legalLinks: config.site.legalLinks.map((link) => {
-      const href = getLocalizedSiteText(link.to, locale.value);
-      return {
-        label: getLocalizedSiteText(link.label, locale.value),
-        href,
-        external: /^https?:\/\//.test(href),
-      };
-    }),
-  }));
-
-  const blogPath = computed(() => path("blog"));
-  const blogExists = computed(() =>
-    router.getRoutes().some((route) => route.path === blogPath.value),
-  );
-
-  const banner = computed(() =>
-    resolveBanner(config.banner, {
-      locale: locale.value,
-      defaultText: t("banner.text"),
-      defaultLinkLabel: t("banner.linkLabel"),
-    }),
-  );
-
-  const socialLinks = computed<NavItem[]>(() => resolveSocialLinks(config.social));
-
-  const mainNav = computed<NavItem[]>(() =>
-    resolveMainNav(config.nav.links, {
-      locale: locale.value,
-      docsPath: path("docs"),
-      blogPath: blogPath.value,
-      blogExists: blogExists.value,
-      docsLabel: t("nav.documentation"),
-      blogLabel: t("nav.blog"),
-      docsDescription: t("nav.docsDescription"),
-      blogDescription: t("nav.blogDescription"),
-    }),
-  );
-
-  return { site, banner, mainNav, socialLinks };
-};

package/app/config/site.utils.ts

@@ -1,36 +0,0 @@
-import type { GinkoDocsLocalizedText } from "../../shared/types/app-config";
-import { defaultLocale, type LocaleCode } from "../../i18n/locales";
-
-export function getLocalizedSiteText(
-  value: GinkoDocsLocalizedText,
-  locale: string,
-  fallbackLocale: LocaleCode = defaultLocale,
-): string {
-  if (typeof value === "string") return value;
-  return value[locale as LocaleCode] ?? value[fallbackLocale] ?? Object.values(value)[0] ?? "";
-}
-
-function isLocalSiteUrl(value: string) {
-  try {
-    const host = new URL(value).hostname;
-    return host === "localhost" || host === "127.0.0.1" || host === "::1";
-  } catch {
-    return false;
-  }
-}
-
-export function resolveSiteUrl(
-  canonicalUrl: string,
-  options: {
-    envUrl?: string;
-    mode?: string;
-  } = {},
-) {
-  const { envUrl, mode } = options;
-
-  if (!envUrl) return canonicalUrl;
-  if (isLocalSiteUrl(envUrl) && mode !== "development" && mode !== "test") {
-    return canonicalUrl;
-  }
-  return envUrl;
-}

package/app/features/docs/components/DocsBreadcrumb.vue

@@ -1,37 +0,0 @@
-<script setup lang="ts">
-import type { HTMLAttributes } from "vue";
-import { cn } from "#ginko-docs/utils";
-import { useI18n } from "#imports";
-
-const props = defineProps<{
-  items: { title: string; path?: string }[];
-  class?: HTMLAttributes["class"];
-}>();
-
-const { t } = useI18n();
-</script>
-
-<template>
-  <nav
-    v-if="items.length"
-    :class="cn('flex flex-wrap items-center gap-1.5 text-sm text-muted-foreground', props.class)"
-    :aria-label="t('docs.breadcrumbs')"
-  >
-    <template v-for="(item, index) in items" :key="item.path ?? item.title">
-      <Icon
-        v-if="index > 0"
-        name="lucide:chevron-right"
-        class="size-3.5 text-border"
-        aria-hidden="true"
-      />
-      <NuxtLink
-        v-if="item.path"
-        :to="item.path"
-        class="rounded-sm transition-colors hover:text-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring"
-      >
-        {{ item.title }}
-      </NuxtLink>
-      <span v-else>{{ item.title }}</span>
-    </template>
-  </nav>
-</template>

package/app/features/docs/components/DocsContributeLinks.vue

@@ -1,75 +0,0 @@
-<script setup lang="ts">
-import type { GinkoDocsAppConfig } from "../../../../shared/types/app-config";
-import { computed } from "vue";
-import { useAppConfig, useI18n, useRoute } from "#imports";
-import { buildRepoEditUrl, buildRepoIssueUrl } from "#ginko-docs/utils/repository";
-
-const props = withDefaults(
-  defineProps<{
-    stem?: string;
-    extension?: string;
-    title: string;
-    variant?: "article" | "rail";
-  }>(),
-  {
-    variant: "article",
-  },
-);
-
-const route = useRoute();
-const { t } = useI18n();
-const repository = (useAppConfig().ginkoDocs as GinkoDocsAppConfig).repository;
-
-const sourcePath = computed(() => {
-  if (!repository || !props.stem) return null;
-  const directory = repository.contentDirectory?.replace(/^\/+|\/+$/g, "") ?? "content";
-  const extension = props.extension?.replace(/^\./, "") || "md";
-  return `${directory}/${props.stem}.${extension}`;
-});
-
-const editUrl = computed(() =>
-  repository && sourcePath.value ? buildRepoEditUrl(repository, sourcePath.value) : null,
-);
-
-const issueUrl = computed(() =>
-  repository
-    ? buildRepoIssueUrl(repository, {
-        title: t("docs.issueTitle", { title: props.title }),
-        body: t("docs.issueBody", { path: route.path }),
-      })
-    : null,
-);
-</script>
-
-<template>
-  <div
-    v-if="repository"
-    :class="
-      variant === 'rail'
-        ? 'flex flex-col gap-2.5 text-sm'
-        : 'flex flex-wrap items-center gap-x-4 gap-y-2 text-sm'
-    "
-    :aria-label="t('docs.contribute')"
-  >
-    <a
-      v-if="editUrl"
-      :href="editUrl"
-      target="_blank"
-      rel="noopener noreferrer"
-      class="inline-flex min-h-9 items-center gap-1.5 font-medium text-muted-foreground transition-colors hover:text-foreground focus-visible:rounded-sm focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring"
-    >
-      <Icon name="lucide:pen-line" class="size-4" aria-hidden="true" />
-      {{ t("docs.editPage") }}
-    </a>
-    <a
-      v-if="issueUrl"
-      :href="issueUrl"
-      target="_blank"
-      rel="noopener noreferrer"
-      class="inline-flex min-h-9 items-center gap-1.5 font-medium text-muted-foreground transition-colors hover:text-foreground focus-visible:rounded-sm focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring"
-    >
-      <Icon name="lucide:circle-alert" class="size-4" aria-hidden="true" />
-      {{ t("docs.reportIssue") }}
-    </a>
-  </div>
-</template>

package/app/features/docs/components/DocsMobileToc.vue

@@ -1,108 +0,0 @@
-<script setup lang="ts">
-import type { HTMLAttributes } from "vue";
-import { ref, watch } from "vue";
-import {
-  Sheet,
-  SheetContent,
-  SheetDescription,
-  SheetTitle,
-  SheetTrigger,
-} from "#ginko-docs/components/ui/sheet";
-import { cn } from "#ginko-docs/utils";
-import type { FlatTocItem } from "#ginko-docs/utils/content";
-import DocsToc from "./DocsToc.vue";
-import { useI18n, useRoute } from "#imports";
-
-const props = defineProps<{
-  items: FlatTocItem[];
-  activeIds?: string[];
-  pageTitle?: string;
-  class?: HTMLAttributes["class"];
-}>();
-
-const sidebarOpen = ref(false);
-const tocOpen = ref(false);
-const route = useRoute();
-const { t } = useI18n();
-
-watch(
-  () => route.hash,
-  () => {
-    tocOpen.value = false;
-  },
-);
-watch(
-  () => route.path,
-  () => {
-    sidebarOpen.value = false;
-    tocOpen.value = false;
-  },
-);
-</script>
-
-<template>
-  <div
-    :class="
-      cn(
-        'sticky top-[var(--site-header-height)] z-30 flex h-11 shrink-0 items-center justify-between border-b border-border bg-background/90 px-4 backdrop-blur-md md:px-6 xl:hidden',
-        props.class,
-      )
-    "
-  >
-    <Sheet v-model:open="sidebarOpen">
-      <SheetTrigger as-child>
-        <button
-          type="button"
-          class="-ml-1 flex h-8 min-w-0 items-center gap-2 rounded-lg px-2 text-sm font-medium text-foreground transition-colors hover:bg-muted focus-visible:ring-2 focus-visible:ring-ring focus-visible:outline-none"
-          :aria-label="t('docs.pageNavigation')"
-        >
-          <Icon
-            name="lucide:panel-left-open"
-            class="size-4 shrink-0 text-muted-foreground"
-            aria-hidden="true"
-          />
-          <span class="truncate">{{ pageTitle ?? t("docs.fallbackTitle") }}</span>
-        </button>
-      </SheetTrigger>
-
-      <SheetContent
-        side="left"
-        class="flex w-[var(--docs-sidebar-width)] max-w-[85vw] flex-col gap-0 p-0"
-      >
-        <div class="border-b border-border px-4 py-3">
-          <SheetTitle class="text-sm font-semibold">{{ t("docs.label") }}</SheetTitle>
-          <SheetDescription class="sr-only">{{ t("docs.pageNavigation") }}</SheetDescription>
-        </div>
-        <div class="min-h-0 flex-1">
-          <DocsSidebar variant="drawer" />
-        </div>
-      </SheetContent>
-    </Sheet>
-
-    <Sheet v-if="items.length" v-model:open="tocOpen">
-      <SheetTrigger as-child>
-        <button
-          type="button"
-          class="-mr-1 flex h-7 shrink-0 items-center gap-1.5 rounded-md px-2.5 text-xs font-medium text-muted-foreground transition-colors hover:bg-muted hover:text-foreground focus-visible:ring-2 focus-visible:ring-ring focus-visible:outline-none"
-        >
-          <Icon name="lucide:list" class="size-3.5" aria-hidden="true" />
-          <span>{{ t("docs.toc") }}</span>
-        </button>
-      </SheetTrigger>
-
-      <SheetContent side="bottom" class="flex max-h-[85dvh] flex-col gap-0 rounded-t-2xl p-0">
-        <div class="flex shrink-0 flex-col items-center border-b border-border px-6 pt-3 pb-4">
-          <div class="mb-4 h-1 w-10 rounded-full bg-border" />
-          <SheetTitle class="self-start text-sm font-semibold">{{ t("docs.toc") }}</SheetTitle>
-          <SheetDescription class="sr-only">{{
-            pageTitle ?? t("docs.fallbackTitle")
-          }}</SheetDescription>
-        </div>
-
-        <div class="flex-1 overflow-y-auto px-6 py-5" @click="tocOpen = false">
-          <DocsToc :items="items" :active-ids="activeIds" :show-title="false" />
-        </div>
-      </SheetContent>
-    </Sheet>
-  </div>
-</template>