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

package/README.md

@@ -8,14 +8,14 @@ Ginko Docs is a Nuxt layer for focused documentation sites. It combines Ginko Co
 - Nuxt `>=4.4.7 <5`
 - Vue `^3.5.35`
 - Vue Router `^5.1.0`
-- Ginko Content `>=0.3.5 <0.4.0`
+- Ginko Content `>=0.4.0-rc.1 <0.5.0`
 
 ## Install
 
 Install the layer and its Ginko Content peer:
 
 ```bash
-pnpm add -D @lupinum/ginko-docs @lupinum/ginko-content@0.3.5
+pnpm add -D @lupinum/ginko-docs@0.3.0-rc.1 @lupinum/ginko-content@0.4.0-rc.1
 ```
 
 Keep the public identity in one shared value:

package/app/components/content/Feedback.vue

@@ -1,7 +1,7 @@
 <script setup lang="ts">
 import { Button } from "#ginko-docs/components/ui/button";
-import { computed, ref } from "vue";
-import { useI18n, useRoute } from "#imports";
+import { computed, ref, watch } from "vue";
+import { useI18n, useRouter } from "#imports";
 import { useGinkoAnalytics } from "#ginko-docs/composables/useGinkoAnalytics";
 import { useGinkoDocsConfig } from "#ginko-docs/composables/useGinkoDocsConfig";
 import { buildRepoIssueUrl } from "#ginko-docs/utils/repository";
@@ -15,7 +15,7 @@ withDefaults(
   },
 );
 const { t, locale } = useI18n();
-const route = useRoute();
+const router = useRouter();
 
 const config = useGinkoDocsConfig();
 const analytics = useGinkoAnalytics();
@@ -24,20 +24,24 @@ const enabled = config.feedback.enabled && analytics.enabled;
 type Sentiment = "positive" | "negative";
 
 const sentiment = ref<Sentiment | null>(null);
+const routePath = computed(() => router.currentRoute.value.path);
+watch(routePath, () => {
+  sentiment.value = null;
+});
 
 const issueUrl = computed(() => {
   const repository = config.repository;
   if (!repository) return null;
   return buildRepoIssueUrl(repository, {
-    title: t("feedback.issueTitle", { path: route.path }),
-    body: t("docs.issueBody", { path: route.path }),
+    title: t("feedback.issueTitle", { path: routePath.value }),
+    body: t("docs.issueBody", { path: routePath.value }),
   });
 });
 
 function selectSentiment(s: Sentiment) {
   if (sentiment.value !== null) return;
   analytics.track("docs-feedback", {
-    path: route.path,
+    path: routePath.value,
     helpful: s === "positive" ? "yes" : "no",
     locale: locale.value,
   });

package/app/composables/useGinkoAnalytics.ts

@@ -10,28 +10,32 @@ export interface GinkoAnalytics {
 
 /**
  * Plausible analytics via the Nuxt Scripts registry script. Fully disabled
- * unless `ginkoDocs.analytics.plausible.domain` is configured — without a
- * domain nothing loads and `track()` is a no-op, so callers never guard.
+ * unless `ginkoDocs.analytics.plausible.scriptId` is configured. Without an
+ * ID, no script loads and `track()` is a no-op, so callers never guard.
  */
 export function useGinkoAnalytics(): GinkoAnalytics {
   const config = useGinkoDocsConfig();
-  const plausible = config.analytics?.plausible;
+  const scriptId = config.analytics?.plausible?.scriptId?.trim();
 
-  if (!plausible?.domain) {
+  if (!scriptId) {
     return { enabled: false, track: () => {} };
   }
 
   const script = useScriptPlausibleAnalytics({
-    domain: plausible.domain,
-    extension: plausible.extensions ?? ["outbound-links"],
-    ...(plausible.scriptSrc ? { scriptInput: { src: plausible.scriptSrc } } : {}),
+    scriptId,
+    // The site ID comes from app.config at runtime. Keep the vendor script
+    // external so Nuxt Scripts does not bundle its legacy fallback URL during
+    // the build-time transform.
+    scriptOptions: { bundle: false },
   });
 
   return {
     enabled: true,
     track: (event, props) => {
       if (!import.meta.client) return;
-      script.proxy.plausible(event, props ? { props } : undefined);
+      const plausible = script.proxy.plausible;
+      if (typeof plausible !== "function") return;
+      plausible(event, props ? { props } : undefined);
     },
   };
 }

package/nuxt.config.ts

@@ -43,7 +43,7 @@ export default defineNuxtConfig({
   },
   mcp: {
     name: "Ginko Docs",
-    version: "0.2.5",
+    version: "0.3.0-rc.1",
   },
   components: {
     dirs: [
@@ -127,7 +127,7 @@ export default defineNuxtConfig({
     markdown: {
       plugins: [
         [
-          "highlight",
+          "shiki",
           {
             preStyles: false,
             transformers: [transformerNotationDiff(), transformerNotationHighlight()],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lupinum/ginko-docs",
-  "version": "0.2.5",
+  "version": "0.3.0-rc.1",
   "description": "A Nuxt documentation layer powered by Ginko Content.",
   "keywords": [
     "content",
@@ -9,14 +9,14 @@
     "markdown",
     "nuxt"
   ],
-  "homepage": "https://github.com/Mat4m0/lupinum-docs-shadcn#readme",
+  "homepage": "https://ginko-docs.lupinum.com",
   "bugs": {
-    "url": "https://github.com/Mat4m0/lupinum-docs-shadcn/issues"
+    "url": "https://github.com/lupinum-dev/ginko-docs/issues"
   },
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Mat4m0/lupinum-docs-shadcn.git",
+    "url": "git+https://github.com/lupinum-dev/ginko-docs.git",
     "directory": "layer"
   },
   "files": [
@@ -72,9 +72,9 @@
     "clsx": "^2.1.1",
     "motion-v": "^2.3.0",
     "nitropack": "^2.13.4",
-    "nuxt-og-image": "^6.7.7",
+    "nuxt-og-image": "^6.7.8",
     "reka-ui": "^2.10.3",
-    "satori": "^0.29.0",
+    "satori": "^0.19.3",
     "shiki": "^4.4.3",
     "tailwind-merge": "^3.6.0",
     "tailwindcss": "^4.3.3",
@@ -82,7 +82,7 @@
     "zod": "^4.4.3"
   },
   "peerDependencies": {
-    "@lupinum/ginko-content": ">=0.3.5 <0.4.0",
+    "@lupinum/ginko-content": ">=0.4.0-rc.1 <0.5.0",
     "nuxt": ">=4.4.7 <5",
     "vue": "^3.5.35",
     "vue-router": "^5.1.0"

package/shared/types/app-config.ts

@@ -58,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;
@@ -99,12 +88,8 @@ 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: Partial<Record<GinkoDocsSocialPlatform, GinkoDocsSocialEntry>>;