@lupinum/ginko-docs 0.4.0-rc.1 → 0.4.0-rc.11

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://raw.githubusercontent.com/lupinum-dev/ginko-docs/main/docs/public/web-app-manifest-512x512.png" width="128" alt="Ginko Docs icon">
+  <img src="https://raw.githubusercontent.com/lupinum-dev/ginko-docs/main/docs/public/favicon.svg" width="128" alt="Ginko Docs icon">
 </p>
 
 <h1 align="center">@lupinum/ginko-docs</h1>
@@ -23,13 +23,13 @@ Use this package when a Nuxt application needs documentation routes, navigation,
 
 - Node.js 22.18, 24.11, or 26 and later maintenance releases
 - Nuxt 4.5.1 or later in the Nuxt 4 line
-- Vue 3.5.35 or later
-- Ginko Content 0.4 prerelease or later in the 0.4 line
+- Vue 3.5.40 or later
+- Ginko Content 1.0.0-beta.9 or later in the 1.x line
 
 ## Installation
 
 ```bash
-pnpm add -D @lupinum/ginko-docs@0.4.0-rc.1 @lupinum/ginko-content@1.0.0-beta.4
+pnpm add -D @lupinum/ginko-docs@0.4.0-rc.11 @lupinum/ginko-content@1.0.0-beta.9
 ```
 
 ```ts
@@ -40,6 +40,29 @@ export default defineNuxtConfig({
 });
 ```
 
+<!-- BEGIN:consumer-onboarding -->
+
+## Use a coding agent
+
+A coding agent is a development tool that can inspect and change your project.
+
+Copy this task prompt into your application agent:
+
+```text [Agent task]
+Use the installed @lupinum/ginko-docs package to implement my requested feature.
+Read the application's instructions first. Resolve @lupinum/ginko-docs/agent-docs
+from this application directory and read the relevant local pages.
+Preserve the existing AGENTS.md. If it has no equivalent guidance, append
+one short note to resolve installed package docs before integration work
+and after dependency changes. Do not install a consumer skill.
+Check the completed feature using this project's normal commands.
+```
+
+The installed documentation matches the package version. If an older version
+has no documentation export, use its README, types and matching release docs.
+
+<!-- END:consumer-onboarding -->
+
 ## Quick start
 
 ```ts
@@ -58,6 +81,14 @@ export default defineGinkoDocsConfig({
 
 Put Markdown files in `content/docs`. Open `/docs` after the Nuxt server starts.
 
+Generate the browser icon set from one square SVG or raster source:
+
+```bash
+pnpm exec ginko-docs-favicons --source public/product-icon.svg --out public
+```
+
+The command writes `favicon.svg`, `favicon-96x96.png`, `apple-touch-icon.png`, and `favicon.ico`. Ginko Docs adds the matching head links and uses the generated 96px PNG in Nuxt-preset social images so every supported source format renders consistently.
+
 ## Exports
 
 - `@lupinum/ginko-docs` is the Nuxt layer entry.

package/app/app.config.ts

@@ -2,6 +2,7 @@ import type { GinkoDocsAppConfig } from "../shared/types/app-config";
 export default {
   ginkoDocs: {
     theme: {
+      preset: "default",
       neutral: "zinc",
       primary: "neutral",
       codeBlocks: "dark",
@@ -16,6 +17,7 @@ export default {
         de: "Dokumentations-Sites auf Basis von Nuxt und Ginko Content.",
       },
       url: "http://localhost:3000",
+      icon: "/favicon.svg",
       logo: { light: "/logo.svg", dark: "/logo-dark.svg" },
       docsSidebarSwitcher: "tabs",
       lupinumAttribution: true,

package/app/app.vue

@@ -7,10 +7,9 @@ import { useCanonicalUrl } from "#ginko-docs/composables/useCanonicalUrl";
 import { useGinkoAnalytics } from "#ginko-docs/composables/useGinkoAnalytics";
 import { useGinkoOgImage } from "#ginko-docs/composables/useGinkoOgImage";
 import { useSchemaJsonLd } from "#ginko-docs/composables/useSchemaJsonLd";
-import { defaultLocale } from "../i18n/locales";
 
 const canonicalUrl = useCanonicalUrl();
-const { locale, locales } = useI18n();
+const { defaultLocale, locale, locales } = useI18n();
 const route = useRoute();
 const { switchPathname } = useLocalizedRouteSwitch();
 const docsConfig = useAppConfig().ginkoDocs;
@@ -18,6 +17,7 @@ const siteUrl = docsConfig.site.url;
 
 useSeoMeta({
   ogSiteName: computed(() => getLocalizedSiteText(docsConfig.site.name, locale.value)),
+  ogType: "website",
   ogUrl: canonicalUrl,
   twitterCard: "summary_large_image",
 });
@@ -35,6 +35,15 @@ useSchemaJsonLd(() => [
     url: siteUrl,
     inLanguage: locale.value,
   },
+  {
+    "@type": "SoftwareApplication",
+    name: getLocalizedSiteText(docsConfig.site.name, locale.value),
+    description: getLocalizedSiteText(docsConfig.site.description, locale.value),
+    url: siteUrl,
+    applicationCategory: "DeveloperApplication",
+    operatingSystem: "Web",
+    ...(docsConfig.social?.github ? { sameAs: [docsConfig.social.github] } : {}),
+  },
 ]);
 
 useHead(() => ({
@@ -42,6 +51,21 @@ useHead(() => ({
     lang: locale.value,
   },
   link: [
+    {
+      key: "favicon-svg",
+      rel: "icon",
+      type: "image/svg+xml",
+      href: docsConfig.site.icon,
+    },
+    {
+      key: "favicon-png",
+      rel: "icon",
+      type: "image/png",
+      sizes: "96x96",
+      href: "/favicon-96x96.png",
+    },
+    { key: "favicon-ico", rel: "icon", sizes: "any", href: "/favicon.ico" },
+    { key: "apple-touch-icon", rel: "apple-touch-icon", href: "/apple-touch-icon.png" },
     { key: "canonical", rel: "canonical", href: canonicalUrl.value },
     ...locales.value.map((entry) => {
       const code = typeof entry === "string" ? entry : entry.code;