@lupinum/ginko-docs 0.3.0-rc.2 → 0.3.0-rc.4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Matthias Amon
+Copyright (c) 2024-present Lupinum OG and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -15,7 +15,7 @@ Ginko Docs is a Nuxt layer for focused documentation sites. It combines Ginko Co
 Install the layer and its Ginko Content peer:
 
 ```bash
-pnpm add -D @lupinum/ginko-docs@0.3.0-rc.2 @lupinum/ginko-content@0.4.0-rc.1
+pnpm add -D @lupinum/ginko-docs@0.3.0-rc.4 @lupinum/ginko-content@0.4.0-rc.1
 ```
 
 Keep the public identity in one shared value:

package/app/app.config.ts

@@ -18,6 +18,7 @@ export default {
       logo: { light: "/logo.svg", dark: "/logo-dark.svg" },
       docsSidebarSwitcher: "tabs",
       lupinumAttribution: true,
+      legalLinks: [],
     },
     nav: { links: "auto", socialIcons: false },
     banner: {

package/app/components/site/SiteFooter.vue

@@ -61,17 +61,29 @@ const resources = computed(() => [
           © <NuxtTime :datetime="currentYearDate" year="numeric" /> {{ site.name }}.
           {{ t("site.footer") }}
         </p>
-        <p v-if="site.lupinumAttribution">
-          {{ t("site.openSourceBy") }}
-          <a
-            href="https://lupinum.com"
-            target="_blank"
-            rel="noopener noreferrer"
-            class="font-medium text-foreground underline decoration-border underline-offset-4 transition-colors hover:decoration-foreground"
+        <div class="flex flex-wrap items-center justify-center gap-x-4 gap-y-2 sm:justify-end">
+          <NuxtLink
+            v-for="link in site.legalLinks"
+            :key="link.href"
+            :to="link.href"
+            :target="link.external ? '_blank' : undefined"
+            :rel="link.external ? 'noopener noreferrer' : undefined"
+            class="underline decoration-border underline-offset-4 transition-colors hover:text-foreground hover:decoration-foreground"
           >
-            Lupinum<span class="sr-only"> ({{ t("nav.externalLink") }})</span> </a
-          >.
-        </p>
+            {{ link.label }}
+          </NuxtLink>
+          <p v-if="site.lupinumAttribution">
+            {{ t("site.openSourceBy") }}
+            <a
+              href="https://lupinum.com"
+              target="_blank"
+              rel="noopener noreferrer"
+              class="font-medium text-foreground underline decoration-border underline-offset-4 transition-colors hover:decoration-foreground"
+            >
+              Lupinum<span class="sr-only"> ({{ t("nav.externalLink") }})</span> </a
+            >.
+          </p>
+        </div>
       </div>
     </div>
   </footer>

package/app/composables/useGinkoAnalytics.ts

@@ -1,6 +1,9 @@
 import { useScriptPlausibleAnalytics } from "#imports";
 import { useGinkoDocsConfig } from "./useGinkoDocsConfig";
 
+const PLAUSIBLE_INITIALIZER =
+  "window.plausible=window.plausible||function(){(plausible.q=plausible.q||[]).push(arguments)},plausible.init=plausible.init||function(i){plausible.o=i||{}};plausible.init()";
+
 export type AnalyticsProps = Record<string, string>;
 
 export interface GinkoAnalytics {
@@ -21,11 +24,19 @@ export function useGinkoAnalytics(): GinkoAnalytics {
     return { enabled: false, track: () => {} };
   }
 
+  const src = `https://plausible.io/js/pa-${scriptId}.js`;
+  useHead({
+    script: [
+      { key: "plausibleAnalytics", src, async: true },
+      { key: "plausibleAnalyticsInit", innerHTML: PLAUSIBLE_INITIALIZER },
+    ],
+  });
+
   const script = useScriptPlausibleAnalytics({
     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.
+    // Plausible verifies its exact snippet in server-rendered HTML. The head
+    // entry above provides it; Nuxt Scripts reuses the same keyed script for
+    // its typed proxy and lifecycle instead of adding a second tracker.
     scriptOptions: { bundle: false },
   });
 

package/app/composables/useSiteNavigation.ts

@@ -22,6 +22,14 @@ export const useSiteNavigation = () => {
     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"));

package/modules/analytics-boundary.ts

@@ -0,0 +1,23 @@
+import { defineNuxtModule } from "@nuxt/kit";
+
+function componentDirectoryPath(entry: string | { path: string }) {
+  return (typeof entry === "string" ? entry : entry.path).replaceAll("\\", "/");
+}
+
+export function isNuxtScriptsComponentDirectory(entry: string | { path: string }) {
+  const path = componentDirectoryPath(entry);
+  return (
+    (path.includes("/node_modules/@nuxt/scripts/") || path.includes("/@nuxt+scripts@")) &&
+    path.endsWith("/node_modules/@nuxt/scripts/dist/runtime/components")
+  );
+}
+
+export default defineNuxtModule({
+  meta: { name: "ginko-docs-analytics-boundary" },
+  setup(_options, nuxt) {
+    nuxt.hook("components:dirs", (dirs) => {
+      const usedDirectories = dirs.filter((entry) => !isNuxtScriptsComponentDirectory(entry));
+      dirs.splice(0, dirs.length, ...usedDirectories);
+    });
+  },
+});

package/modules/feature-routing.ts

@@ -1,6 +1,6 @@
-import { defineNuxtModule } from "@nuxt/kit";
+import { defineNuxtModule, installModule } from "@nuxt/kit";
 import type {} from "@lupinum/ginko-content";
-import { localeCodes, localizedPath } from "../i18n/locales";
+import { defaultLocale, localeCodes, locales, localizedPath } from "../i18n/locales";
 import { routeSlugs } from "../shared/route-slugs";
 
 interface PageRoute {
@@ -24,7 +24,28 @@ export function removeBlogPages(pages: PageRoute[], blogEnabled: boolean) {
 
 export default defineNuxtModule({
   meta: { name: "ginko-docs-feature-routing" },
-  setup(_options, nuxt) {
+  async setup(_options, nuxt) {
+    const fallback = locales.find((locale) => locale.code === defaultLocale);
+    if (!fallback) throw new Error(`Missing locale definition for ${defaultLocale}.`);
+    const configuredLocales = nuxt.options.i18n?.locales;
+    if (!Array.isArray(configuredLocales) || configuredLocales.length === 0) {
+      nuxt.options.i18n = {
+        ...nuxt.options.i18n,
+        locales: [{ code: fallback.code, language: fallback.language, name: fallback.name }],
+      };
+    } else if (configuredLocales.length > 1) {
+      const fallbackIndex = configuredLocales.findIndex(
+        (locale) =>
+          typeof locale === "object" &&
+          locale !== null &&
+          locale.code === fallback.code &&
+          locale.language === fallback.language &&
+          locale.name === fallback.name,
+      );
+      if (fallbackIndex >= 0) configuredLocales.splice(fallbackIndex, 1);
+    }
+    await installModule("@nuxtjs/i18n");
+
     let blogEnabled = false;
 
     nuxt.hook("content:context", (context) => {

package/nuxt.config.ts

@@ -1,17 +1,29 @@
 import { fileURLToPath } from "node:url";
 import { dirname, join } from "node:path";
+import { readFileSync } from "node:fs";
 import tailwindcss from "@tailwindcss/vite";
 import { transformerNotationDiff, transformerNotationHighlight } from "@shikijs/transformers";
 import darkPlus from "shiki/dist/themes/dark-plus.mjs";
 import lightPlus from "shiki/dist/themes/light-plus.mjs";
 import { contentComponentPolicy, contentComponentTags } from "./tags";
 import { i18nPages } from "./i18n/routes";
-import { localeCodes, localizedPath } from "./i18n/locales";
+import { defaultLocale, localeCodes, locales, localizedPath } from "./i18n/locales";
 import { routeSlugs } from "./shared/route-slugs";
 import { layerIconCollections, layerIconNames } from "./icon-bundle";
 
 const root = dirname(fileURLToPath(import.meta.url));
 const app = join(root, "app");
+const publicSansDirectory = join(root, "public/fonts/public-sans");
+const publicSansFamilies = [400, 500, 600, 700].map((weight) => ({
+  name: "Public Sans",
+  global: true,
+  display: "swap" as const,
+  weight,
+  style: "normal",
+  src: `data:font/woff;base64,${readFileSync(
+    join(publicSansDirectory, `public-sans-${weight}-normal-latin.woff`),
+  ).toString("base64")}`,
+}));
 
 export default defineNuxtConfig({
   build: {
@@ -25,10 +37,10 @@ export default defineNuxtConfig({
     join(root, "modules/feature-routing"),
     "@nuxt/icon",
     "@nuxt/fonts",
-    "@nuxtjs/i18n",
     "@lupinum/ginko-content",
     "@nuxt/image",
     "@nuxt/scripts",
+    join(root, "modules/analytics-boundary"),
     "nuxt-og-image",
     "@nuxtjs/sitemap",
     "@nuxtjs/robots",
@@ -43,7 +55,7 @@ export default defineNuxtConfig({
   },
   mcp: {
     name: "Ginko Docs",
-    version: "0.3.0-rc.2",
+    version: "0.3.0-rc.4",
   },
   components: {
     dirs: [
@@ -101,17 +113,24 @@ export default defineNuxtConfig({
     },
   },
   fonts: {
-    defaults: {
-      weights: [400, 500, 600, 700],
-      styles: ["normal"],
-      subsets: ["latin", "latin-ext"],
+    families: publicSansFamilies,
+    providers: {
+      adobe: false,
+      bunny: false,
+      fontshare: false,
+      fontsource: false,
+      google: false,
+      googleicons: false,
+      npm: false,
     },
-    families: [{ name: "Public Sans", provider: "google", global: true }],
   },
   i18n: {
     customRoutes: "config",
     defaultLocale: "en",
     detectBrowserLanguage: false,
+    locales: locales
+      .filter((locale) => locale.code === defaultLocale)
+      .map(({ code, language, name }) => ({ code, language, name })),
     pages: i18nPages,
     strategy: "prefix_except_default",
     vueI18n: join(root, "i18n/i18n.config.ts"),
@@ -189,17 +208,6 @@ export default defineNuxtConfig({
     },
   },
   vite: {
-    optimizeDeps: {
-      include: [
-        "@vueuse/core",
-        "class-variance-authority",
-        "clsx",
-        "motion-v",
-        "reka-ui",
-        "tailwind-merge",
-        "zod",
-      ],
-    },
     resolve: {
       dedupe: ["@lupinum/ginko-content", "vue", "vue-router"],
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lupinum/ginko-docs",
-  "version": "0.3.0-rc.2",
+  "version": "0.3.0-rc.4",
   "description": "A Nuxt documentation layer powered by Ginko Content.",
   "keywords": [
     "content",
@@ -23,6 +23,7 @@
     "app",
     "i18n",
     "modules",
+    "public",
     "runtime",
     "server",
     "shared",

package/public/fonts/public-sans/LICENSE

@@ -0,0 +1,93 @@
+Copyright 2015 The Public Sans Project Authors (https://github.com/uswds/public-sans) PublicSans-Italic[wght].ttf: Copyright 2015 The Public Sans Project Authors (https://github.com/uswds/public-sans)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/public/fonts/public-sans/README.md

@@ -0,0 +1,12 @@
+# Public Sans
+
+These Latin-subset WOFF files are copied from `@fontsource/public-sans@5.3.0`:
+
+- `public-sans-latin-400-normal.woff`
+- `public-sans-latin-500-normal.woff`
+- `public-sans-latin-600-normal.woff`
+- `public-sans-latin-700-normal.woff`
+
+They are renamed to the convention expected by the Nuxt Fonts local provider.
+The upstream package is available at <https://fontsource.org/fonts/public-sans>.
+Public Sans is licensed under the SIL Open Font License 1.1; see `LICENSE`.

package/shared/types/app-config.ts

@@ -71,6 +71,8 @@ export interface GinkoDocsAppConfig {
     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. */