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

package/dist/config.mjs

@@ -0,0 +1,114 @@
+import { collection, f, single } from '@lupinum/ginko';
+import { B as BLOG_PATH, C as CHANGELOG_PATH } from './shared/ginko-docs.BwbF7JBR.mjs';
+export { components } from '@lupinum/ginko-components/registry';
+
+function localized(locales, path) {
+  const [main] = locales;
+  if (main === void 0) throw new Error("[ginko-docs] `locales` is empty. Fix: pass the same list as `locales` in defineSite.");
+  return Object.fromEntries(locales.map((l) => [l, l === main ? path : `/${l}${path}`]));
+}
+function docsCollection(opts) {
+  const { locales } = opts;
+  const base = opts.base ?? "/docs";
+  return collection({
+    label: opts.label ?? "Docs",
+    source: "files",
+    max: opts.max ?? 500,
+    order: "manual",
+    route: localized(locales, `${base}/[slug]`),
+    fields: {
+      title: f.text("Title"),
+      description: f.longtext("Description", { optional: true }),
+      /** Starts a group in the side navigation under this heading; the pages after it belong to it until the next one. */
+      section: f.text("Section", { optional: true }),
+      /** Nests the entry under another doc in the side navigation and the breadcrumbs. */
+      parent: f.ref("Parent page", { to: "docs", optional: true }),
+      /** Section tab above the side navigation; a page without one follows the tab of the page before it. Children follow their parent. */
+      tab: f.text("Tab", { optional: true, max: 30 }),
+      /** A short label next to the entry in the side navigation, e.g. "New". */
+      badge: f.text("Badge", { optional: true, max: 20 }),
+      /** An icon name such as `lucide:book-open` (any installed Iconify set), shown before the title in the side navigation. */
+      icon: f.text("Icon", { optional: true, max: 60, translate: false }),
+      slug: f.slug("Address", { from: "title" }),
+      body: f.markdown("Text", { profile: "page" })
+    }
+  });
+}
+function docsHome() {
+  return single({
+    label: "Start page",
+    source: "files",
+    fields: {
+      title: f.text("Title", { max: 120 }),
+      description: f.longtext("Description", { optional: true, max: 400 }),
+      /** A command shown with a copy button, e.g. `pnpm add @lupinum/ginko`. */
+      install: f.text("Install command", { optional: true, max: 200, translate: false }),
+      /** Buttons under the description; the first one is the main one. */
+      links: f.list("Links", { itemLabel: "Link", fields: { label: f.text("Text", { max: 40 }), href: f.text("Target", { max: 300 }) }, max: 2, default: [] }),
+      features: f.list("Features", {
+        itemLabel: "Feature",
+        fields: {
+          icon: f.text("Icon", { optional: true, max: 60, translate: false }),
+          title: f.text("Title", { max: 80 }),
+          description: f.longtext("Description", { max: 300 }),
+          href: f.text("Link", { optional: true, max: 300 })
+        },
+        max: 12,
+        default: []
+      }),
+      body: f.markdown("Text", { profile: "page", optional: true })
+    }
+  });
+}
+function blogCollections(opts) {
+  const { locales } = opts;
+  return {
+    posts: collection({
+      label: "Posts",
+      source: "files",
+      max: opts.max ?? 500,
+      order: { field: "date", dir: "desc" },
+      route: localized(locales, `${BLOG_PATH}/[slug]`),
+      fields: {
+        title: f.text("Title"),
+        description: f.longtext("Description", { optional: true }),
+        date: f.date("Date"),
+        authors: f.refs("Authors", { to: "authors", optional: true }),
+        image: f.image("Image", { optional: true }),
+        tags: f.list("Tags", { itemLabel: "Tag", fields: { tag: f.text("Tag", { max: 40 }) }, max: 10, optional: true }),
+        slug: f.slug("Address", { from: "title" }),
+        body: f.markdown("Text", { profile: "page" })
+      }
+    }),
+    authors: collection({
+      label: "Authors",
+      source: "files",
+      max: 100,
+      order: "manual",
+      fields: {
+        name: f.text("Name"),
+        role: f.text("Role", { optional: true }),
+        avatar: f.image("Image", { optional: true }),
+        /** Shown as a link on the author's name. */
+        url: f.text("Website", { format: "url", optional: true })
+      }
+    })
+  };
+}
+function changelogCollection(opts = {}) {
+  return collection({
+    label: "Changelog",
+    source: "files",
+    max: opts.max ?? 500,
+    order: { field: "date", dir: "desc" },
+    fields: {
+      version: f.text("Version", { max: 40, translate: false }),
+      date: f.date("Date"),
+      body: f.markdown("Text", { profile: "page" })
+    }
+  });
+}
+const blogPages = (opts) => localized(opts.locales, BLOG_PATH);
+const changelogPages = (opts) => localized(opts.locales, CHANGELOG_PATH);
+
+export { blogCollections, blogPages, changelogCollection, changelogPages, docsCollection, docsHome };

package/dist/pages.d.mts

@@ -0,0 +1,5 @@
+import { NuxtModule } from 'nuxt/schema';
+
+declare const docsPages: NuxtModule;
+
+export { docsPages as default };

package/dist/pages.d.ts

@@ -0,0 +1,5 @@
+import { NuxtModule } from 'nuxt/schema';
+
+declare const docsPages: NuxtModule;
+
+export { docsPages as default };

package/dist/pages.mjs

@@ -0,0 +1,36 @@
+import { defineNuxtModule, createResolver, extendPages, addServerHandler, useLogger } from '@nuxt/kit';
+import { B as BLOG_PATH, C as CHANGELOG_PATH } from './shared/ginko-docs.BwbF7JBR.mjs';
+
+const docsPages = defineNuxtModule({
+  meta: { name: "@lupinum/ginko-docs/pages" },
+  setup(_, nuxt) {
+    const { resolve } = createResolver(import.meta.url);
+    const site = nuxt.options.ginko;
+    const bricks = site?.bricks ?? {};
+    const main = site?.locales?.[0] ?? "";
+    const base = bricks.docs?.route?.[main]?.replace(/\/\[slug\]$/, "") ?? "/docs";
+    extendPages((pages) => {
+      const taken = new Set(pages.map((p) => p.path));
+      const add = (name, path, file) => {
+        if (!taken.has(path)) pages.push({ name, path, file: resolve(`../app/docs-pages/${file}`) });
+      };
+      add("docs-slug", `${base}/:slug()`, "doc.vue");
+      add("docs", base, "docs.vue");
+      add("index", "/", "index.vue");
+      if (bricks.posts) {
+        add("blog", BLOG_PATH, "blog.vue");
+        add("blog-slug", `${BLOG_PATH}/:slug()`, "post.vue");
+      }
+      if (bricks.changelog) add("changelog", CHANGELOG_PATH, "changelog.vue");
+    });
+    if (bricks.posts) {
+      addServerHandler({ route: `${BLOG_PATH}/rss.xml`, method: "get", handler: resolve("../server/feeds/blog.get") });
+      addServerHandler({ route: `/:locale${BLOG_PATH}/rss.xml`, method: "get", handler: resolve("../server/feeds/blog-locale.get") });
+    }
+    const logger = useLogger("ginko-docs");
+    if (bricks.posts && !site?.pages?.blog) logger.warn("The site has a blog but no `blog: blogPages({ locales })` in `pages`: the blog list is missing from the sitemap and the static build.");
+    if (bricks.changelog && !site?.pages?.changelog) logger.warn("The site has a changelog but no `changelog: changelogPages({ locales })` in `pages`: it is missing from the sitemap and the static build.");
+  }
+});
+
+export { docsPages as default };

package/dist/shared/ginko-docs.BwbF7JBR.mjs

@@ -0,0 +1,4 @@
+const BLOG_PATH = "/blog";
+const CHANGELOG_PATH = "/changelog";
+
+export { BLOG_PATH as B, CHANGELOG_PATH as C };

package/i18n/de.json

@@ -0,0 +1 @@
+{"docs":{"docs":"Doku","edit":"Seite bearbeiten","issue":"Fehler melden","top":"Nach oben","updated":"Zuletzt geändert am","copyPage":"Seite kopieren","copied":"Kopiert","copyFailed":"Kopieren nicht möglich","table":"Tabelle, scrollbar","installCommand":"Installationsbefehl","searchResults":"Suchergebnisse","copyCommand":"Befehl kopieren","moreActions":"Weitere Seitenaktionen","viewMarkdown":"Als Markdown ansehen","viewMarkdownHint":"Die Seite als reiner Text","openChatGpt":"In ChatGPT öffnen","openClaude":"In Claude öffnen","askHint":"Fragen zu dieser Seite stellen","askPrompt":"Lies {url} und beantworte Fragen dazu.","pageActions":"Seitenaktionen","skip":"Zum Inhalt","nav":"Doku-Navigation","onThisPage":"Auf dieser Seite","search":"Suchen","searchPlaceholder":"Doku durchsuchen …","searchHint":"Tippe, um Seiten und Abschnitte zu finden.","noResults":"Nichts gefunden für „{query}“.","searchMove":"wählen","searchOpen":"öffnen","close":"Schließen","previous":"Zurück","next":"Weiter","pager":"Vorige und nächste Seite","language":"Sprache","sections":"Bereiche","breadcrumb":"Pfad","theme":{"label":"Darstellung","auto":"Auto","light":"Hell","dark":"Dunkel","toggle":"Zwischen hell und dunkel wechseln"},"bannerClose":"Hinweis schließen","footerNav":"Fußzeile","builtWith":"Erstellt mit Ginko","toggle":"Unterseiten von {title} ein- oder ausklappen","blog":"Blog","changelog":"Änderungen","by":"Von","rss":"RSS-Feed","siteLinks":"Hauptbereiche","siteMenu":"Hauptmenü","blogLead":"Neuigkeiten, Anleitungen und Einblicke.","changelogLead":"Was sich mit jeder Version geändert hat.","draft":"Entwurf","readMore":"Weiterlesen","example":{"preview":"Vorschau","source":"Markdown"},"notFound":{"title":"Seite nicht gefunden","text":"Diese Seite gibt es nicht oder sie ist umgezogen.","home":"Zur Startseite"},"error":{"title":"Etwas ist schiefgelaufen","text":"Die Seite konnte nicht geladen werden. Versuche es gleich noch einmal."}}}

package/i18n/en.json

@@ -0,0 +1 @@
+{"docs":{"docs":"Docs","edit":"Edit this page","issue":"Report an issue","top":"Back to top","updated":"Last updated","copyPage":"Copy page","copied":"Copied","copyFailed":"Could not copy","table":"Table, scrollable","installCommand":"Install command","searchResults":"Search results","copyCommand":"Copy command","moreActions":"More page actions","viewMarkdown":"View as Markdown","viewMarkdownHint":"The page as plain text","openChatGpt":"Open in ChatGPT","openClaude":"Open in Claude","askHint":"Ask questions about this page","askPrompt":"Read {url} and answer questions about it.","pageActions":"Page actions","skip":"Skip to content","nav":"Docs navigation","onThisPage":"On this page","search":"Search","searchPlaceholder":"Search the docs…","searchHint":"Type to search pages and sections.","noResults":"No results for “{query}”.","searchMove":"to move","searchOpen":"to open","close":"Close","previous":"Previous","next":"Next","pager":"Previous and next page","language":"Language","sections":"Sections","breadcrumb":"Breadcrumb","theme":{"label":"Appearance","auto":"Auto","light":"Light","dark":"Dark","toggle":"Switch between light and dark"},"bannerClose":"Dismiss notice","footerNav":"Footer","builtWith":"Built with Ginko","toggle":"Show or hide subpages of {title}","blog":"Blog","changelog":"Changelog","by":"By","rss":"RSS feed","siteLinks":"Main","siteMenu":"Main menu","blogLead":"News, guides and insights.","changelogLead":"What changed with each version.","draft":"Draft","readMore":"Read more","example":{"preview":"Preview","source":"Markdown"},"notFound":{"title":"Page not found","text":"This page does not exist or has moved.","home":"Go to the home page"},"error":{"title":"Something went wrong","text":"The page could not be loaded. Please try again in a moment."}}}

package/icons/README.md

@@ -0,0 +1,2 @@
+Brand icons of the `docs` icon collection (`docs:github`, `docs:openai`, ...), from Simple Icons
+(@iconify-json/simple-icons 1.2.99, CC0 1.0). Brand names and logos belong to their owners.

package/icons/bluesky.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M5.202 2.857C7.954 4.922 10.913 9.11 12 11.358c1.087-2.247 4.046-6.436 6.798-8.501C20.783 1.366 24 .213 24 3.883c0 .732-.42 6.156-.667 7.037c-.856 3.061-3.978 3.842-6.755 3.37c4.854.826 6.089 3.562 3.422 6.299c-5.065 5.196-7.28-1.304-7.847-2.97c-.104-.305-.152-.448-.153-.327c0-.121-.05.022-.153.327c-.568 1.666-2.782 8.166-7.847 2.97c-2.667-2.737-1.432-5.473 3.422-6.3c-2.777.473-5.899-.308-6.755-3.369C.42 10.04 0 4.615 0 3.883c0-3.67 3.217-2.517 5.202-1.026"/></svg>

package/icons/claude.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="m4.714 15.956l4.718-2.648l.079-.23l-.08-.128h-.23l-.79-.048l-2.695-.073l-2.337-.097l-2.265-.122l-.57-.121l-.535-.704l.055-.353l.48-.321l.685.06l1.518.104l2.277.157l1.651.098l2.447.255h.389l.054-.158l-.133-.097l-.103-.098l-2.356-1.596l-2.55-1.688l-1.336-.972l-.722-.491L2 6.223l-.158-1.008l.656-.722l.88.06l.224.061l.893.686l1.906 1.476l2.49 1.833l.364.304l.146-.104l.018-.072l-.164-.274l-1.354-2.446l-1.445-2.49l-.644-1.032l-.17-.619a3 3 0 0 1-.103-.729L6.287.133L6.7 0l.995.134l.42.364l.619 1.415L9.735 4.14l1.555 3.03l.455.898l.243.832l.09.255h.159V9.01l.127-1.706l.237-2.095l.23-2.695l.08-.76l.376-.91l.747-.492l.583.28l.48.685l-.067.444l-.286 1.851l-.558 2.903l-.365 1.942h.213l.243-.242l.983-1.306l1.652-2.064l.728-.82l.85-.904l.547-.431h1.032l.759 1.129l-.34 1.166l-1.063 1.347l-.88 1.142l-1.263 1.7l-.79 1.36l.074.11l.188-.02l2.853-.606l1.542-.28l1.84-.315l.832.388l.09.395l-.327.807l-1.967.486l-2.307.462l-3.436.813l-.043.03l.049.061l1.548.146l.662.036h1.62l3.018.225l.79.522l.473.638l-.08.485l-1.213.62l-1.64-.389l-3.825-.91l-1.31-.329h-.183v.11l1.093 1.068l2.003 1.81l2.508 2.33l.127.578l-.321.455l-.34-.049l-2.204-1.657l-.85-.747l-1.925-1.62h-.127v.17l.443.649l2.343 3.521l.122 1.08l-.17.353l-.607.213l-.668-.122l-1.372-1.924l-1.415-2.168l-1.141-1.943l-.14.08l-.674 7.254l-.316.37l-.728.28l-.607-.461l-.322-.747l.322-1.476l.388-1.924l.316-1.53l.285-1.9l.17-.632l-.012-.042l-.14.018l-1.432 1.967l-2.18 2.945l-1.724 1.845l-.413.164l-.716-.37l.066-.662l.401-.589l2.386-3.036l1.439-1.882l.929-1.086l-.006-.158h-.055L4.138 18.56l-1.13.146l-.485-.456l.06-.746l.231-.243l1.907-1.312Z"/></svg>

package/icons/discord.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M20.317 4.37a19.8 19.8 0 0 0-4.885-1.515a.074.074 0 0 0-.079.037c-.21.375-.444.864-.608 1.25a18.3 18.3 0 0 0-5.487 0a13 13 0 0 0-.617-1.25a.08.08 0 0 0-.079-.037A19.7 19.7 0 0 0 3.677 4.37a.1.1 0 0 0-.032.027C.533 9.046-.32 13.58.099 18.057a.08.08 0 0 0 .031.057a19.9 19.9 0 0 0 5.993 3.03a.08.08 0 0 0 .084-.028a14 14 0 0 0 1.226-1.994a.076.076 0 0 0-.041-.106a13 13 0 0 1-1.872-.892a.077.077 0 0 1-.008-.128a10 10 0 0 0 .372-.292a.07.07 0 0 1 .077-.01c3.928 1.793 8.18 1.793 12.062 0a.07.07 0 0 1 .078.01q.181.149.373.292a.077.077 0 0 1-.006.127a12.3 12.3 0 0 1-1.873.892a.077.077 0 0 0-.041.107c.36.698.772 1.362 1.225 1.993a.08.08 0 0 0 .084.028a19.8 19.8 0 0 0 6.002-3.03a.08.08 0 0 0 .032-.054c.5-5.177-.838-9.674-3.549-13.66a.06.06 0 0 0-.031-.03M8.02 15.33c-1.182 0-2.157-1.085-2.157-2.419c0-1.333.956-2.419 2.157-2.419c1.21 0 2.176 1.096 2.157 2.42c0 1.333-.956 2.418-2.157 2.418m7.975 0c-1.183 0-2.157-1.085-2.157-2.419c0-1.333.955-2.419 2.157-2.419c1.21 0 2.176 1.096 2.157 2.42c0 1.333-.946 2.418-2.157 2.418"/></svg>

package/icons/github.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M12 .297c-6.63 0-12 5.373-12 12c0 5.303 3.438 9.8 8.205 11.385c.6.113.82-.258.82-.577c0-.285-.01-1.04-.015-2.04c-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729c1.205.084 1.838 1.236 1.838 1.236c1.07 1.835 2.809 1.305 3.495.998c.108-.776.417-1.305.76-1.605c-2.665-.3-5.466-1.332-5.466-5.93c0-1.31.465-2.38 1.235-3.22c-.135-.303-.54-1.523.105-3.176c0 0 1.005-.322 3.3 1.23c.96-.267 1.98-.399 3-.405c1.02.006 2.04.138 3 .405c2.28-1.552 3.285-1.23 3.285-1.23c.645 1.653.24 2.873.12 3.176c.765.84 1.23 1.91 1.23 3.22c0 4.61-2.805 5.625-5.475 5.92c.42.36.81 1.096.81 2.22c0 1.606-.015 2.896-.015 3.286c0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>

package/icons/linkedin.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M20.447 20.452h-3.554v-5.569c0-1.328-.027-3.037-1.852-3.037c-1.853 0-2.136 1.445-2.136 2.939v5.667H9.351V9h3.414v1.561h.046c.477-.9 1.637-1.85 3.37-1.85c3.601 0 4.267 2.37 4.267 5.455v6.286zM5.337 7.433a2.06 2.06 0 0 1-2.063-2.065a2.064 2.064 0 1 1 2.063 2.065m1.782 13.019H3.555V9h3.564zM22.225 0H1.771C.792 0 0 .774 0 1.729v20.542C0 23.227.792 24 1.771 24h20.451C23.2 24 24 23.227 24 22.271V1.729C24 .774 23.2 0 22.222 0z"/></svg>

package/icons/mastodon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M23.268 5.313c-.35-2.578-2.617-4.61-5.304-5.004C17.51.242 15.792 0 11.813 0h-.03c-3.98 0-4.835.242-5.288.309C3.882.692 1.496 2.518.917 5.127C.64 6.412.61 7.837.661 9.143c.074 1.874.088 3.745.26 5.611c.118 1.24.325 2.47.62 3.68c.55 2.237 2.777 4.098 4.96 4.857c2.336.792 4.849.923 7.256.38q.398-.092.786-.213c.585-.184 1.27-.39 1.774-.753a.06.06 0 0 0 .023-.043v-1.809a.05.05 0 0 0-.02-.041a.05.05 0 0 0-.046-.01a20.3 20.3 0 0 1-4.709.545c-2.73 0-3.463-1.284-3.674-1.818a5.6 5.6 0 0 1-.319-1.433a.053.053 0 0 1 .066-.054c1.517.363 3.072.546 4.632.546c.376 0 .75 0 1.125-.01c1.57-.044 3.224-.124 4.768-.422q.059-.011.11-.024c2.435-.464 4.753-1.92 4.989-5.604c.008-.145.03-1.52.03-1.67c.002-.512.167-3.63-.024-5.545m-3.748 9.195h-2.561V8.29c0-1.309-.55-1.976-1.67-1.976c-1.23 0-1.846.79-1.846 2.35v3.403h-2.546V8.663c0-1.56-.617-2.35-1.848-2.35c-1.112 0-1.668.668-1.67 1.977v6.218H4.822V8.102q0-1.965 1.011-3.12c.696-.77 1.608-1.164 2.74-1.164c1.311 0 2.302.5 2.962 1.498l.638 1.06l.638-1.06c.66-.999 1.65-1.498 2.96-1.498c1.13 0 2.043.395 2.74 1.164q1.012 1.155 1.012 3.12z"/></svg>

package/icons/openai.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M22.282 9.821a6 6 0 0 0-.516-4.91a6.05 6.05 0 0 0-6.51-2.9A6.065 6.065 0 0 0 4.981 4.18a6 6 0 0 0-3.998 2.9a6.05 6.05 0 0 0 .743 7.097a5.98 5.98 0 0 0 .51 4.911a6.05 6.05 0 0 0 6.515 2.9A6 6 0 0 0 13.26 24a6.06 6.06 0 0 0 5.772-4.206a6 6 0 0 0 3.997-2.9a6.06 6.06 0 0 0-.747-7.073M13.26 22.43a4.48 4.48 0 0 1-2.876-1.04l.141-.081l4.779-2.758a.8.8 0 0 0 .392-.681v-6.737l2.02 1.168a.07.07 0 0 1 .038.052v5.583a4.504 4.504 0 0 1-4.494 4.494M3.6 18.304a4.47 4.47 0 0 1-.535-3.014l.142.085l4.783 2.759a.77.77 0 0 0 .78 0l5.843-3.369v2.332a.08.08 0 0 1-.033.062L9.74 19.95a4.5 4.5 0 0 1-6.14-1.646M2.34 7.896a4.5 4.5 0 0 1 2.366-1.973V11.6a.77.77 0 0 0 .388.677l5.815 3.354l-2.02 1.168a.08.08 0 0 1-.071 0l-4.83-2.786A4.504 4.504 0 0 1 2.34 7.872zm16.597 3.855l-5.833-3.387L15.119 7.2a.08.08 0 0 1 .071 0l4.83 2.791a4.494 4.494 0 0 1-.676 8.105v-5.678a.79.79 0 0 0-.407-.667m2.01-3.023l-.141-.085l-4.774-2.782a.78.78 0 0 0-.785 0L9.409 9.23V6.897a.07.07 0 0 1 .028-.061l4.83-2.787a4.5 4.5 0 0 1 6.68 4.66zm-12.64 4.135l-2.02-1.164a.08.08 0 0 1-.038-.057V6.075a4.5 4.5 0 0 1 7.375-3.453l-.142.08L8.704 5.46a.8.8 0 0 0-.393.681zm1.097-2.365l2.602-1.5l2.607 1.5v2.999l-2.597 1.5l-2.607-1.5Z"/></svg>

package/icons/x.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M14.234 10.162L22.977 0h-2.072l-7.591 8.824L7.251 0H.258l9.168 13.343L.258 24H2.33l8.016-9.318L16.749 24h6.993zm-2.837 3.299l-.929-1.329L3.076 1.56h3.182l5.965 8.532l.929 1.329l7.754 11.09h-3.182z"/></svg>

package/icons/youtube.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M23.498 6.186a3.02 3.02 0 0 0-2.122-2.136C19.505 3.545 12 3.545 12 3.545s-7.505 0-9.377.505A3.02 3.02 0 0 0 .502 6.186C0 8.07 0 12 0 12s0 3.93.502 5.814a3.02 3.02 0 0 0 2.122 2.136c1.871.505 9.376.505 9.376.505s7.505 0 9.377-.505a3.02 3.02 0 0 0 2.122-2.136C24 15.93 24 12 24 12s0-3.93-.502-5.814M9.545 15.568V8.432L15.818 12z"/></svg>

package/nuxt.config.ts

@@ -1,218 +1,43 @@
-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 { defaultLocale, localeCodes, locales, localizedPath } from "./i18n/locales";
-import { routeSlugs } from "./shared/route-slugs";
-import { layerIconCollections, layerIconNames } from "./icon-bundle";
-import packageMetadata from "./package.json" with { type: "json" };
+// The docs layer. A site extends it and brings ginko.config.ts (with docsCollection), content/ and branding:
+//   export default defineNuxtConfig({ extends: ['@lupinum/ginko-docs'], modules: ['@lupinum/ginko/nuxt'], ginko })
+// Standalone it is a whole docs site; inside a larger site (`extends` next to the site's own pages and layout) it
+// adds only the docs pages, styled from the site's shadcn-style tokens (README: "Inside an existing site").
+import { fileURLToPath } from 'node:url'
 
-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")}`,
-}));
+const here = (path: string) => fileURLToPath(new URL(path, import.meta.url))
+
+// Icons the layer's own components use. They go into the client bundle; icon names in the site's content
+// (the `icon` field) are found by the scan. No icon API: everything is bundled, so static hosting works offline.
+const icons = [
+  'arrow-left', 'arrow-right', 'arrow-up', 'arrow-up-right', 'check', 'chevron-down', 'chevron-right', 'circle-alert',
+  'copy', 'corner-down-left', 'file-text', 'hash', 'languages', 'menu', 'moon', 'panel-left', 'pencil', 'rss',
+  'search', 'sun', 'text-align-start', 'x',
+].map((name) => `lucide:${name}`)
 
 export default defineNuxtConfig({
-  build: {
-    transpile: ["@lupinum/ginko-docs"],
-  },
-  $meta: { name: "ginko-docs" },
-  compatibilityDate: "2025-07-15",
-  alias: { "#ginko-docs": app },
-  css: [join(app, "assets/css/tailwind.css"), join(app, "assets/css/prose.css")],
-  modules: [
-    join(root, "modules/syntax-highlighting"),
-    join(root, "modules/feature-routing"),
-    "@nuxt/icon",
-    "@nuxt/fonts",
-    "@lupinum/ginko-content",
-    "@nuxt/image",
-    "@nuxt/scripts",
-    join(root, "modules/analytics-boundary"),
-    "nuxt-og-image",
-    "@nuxtjs/sitemap",
-    "@nuxtjs/robots",
-    "@nuxtjs/color-mode",
-    "@nuxtjs/mcp-toolkit",
-  ],
-  ogImage: {
-    zeroRuntime: true,
-    // Satori renders queue up behind page prerendering on modest build
-    // machines; the default 15s budget is too tight under that contention.
-    security: { renderTimeout: 120_000 },
-  },
-  mcp: {
-    name: "Ginko Docs",
-    version: packageMetadata.version,
-  },
-  components: {
-    dirs: [
-      {
-        path: join(app, "components/site"),
-        pathPrefix: false,
-        global: true,
-        pattern: [
-          "SiteBanner.vue",
-          "SiteFooter.vue",
-          "SiteHeader.vue",
-          "SiteInteractionLayer.vue",
-          "SiteLocaleSwitcher.vue",
-          "SiteLogoMark.vue",
-          "SiteSkipLink.vue",
-          "SiteSocialLinks.vue",
-        ],
-      },
-      {
-        path: join(app, "features/docs/components"),
-        pathPrefix: false,
-        global: true,
-        pattern: "DocsSidebar.vue",
-      },
-      { path: join(app, "components/mdc"), pathPrefix: false, global: true },
-      { path: join(app, "components/prose"), pathPrefix: false, global: true },
-    ],
-  },
-  colorMode: { classSuffix: "" },
+  modules: ['@lupinum/ginko-components', '@nuxt/icon', '@lupinum/ginko-docs/pages'],
+  // Tells @lupinum/ginko to keep each page's repository path (`source`) in the served bundle, for "Edit this page".
+  // A config hook, not one in modules/pages.ts: it is registered before any module runs, whatever the module order.
+  hooks: { 'ginko:files': (options) => { options.keepSource = true } },
+  css: [here('./app/assets/docs.css')],
   icon: {
-    provider: "none",
+    provider: 'none',
     fallbackToApi: false,
-    customCollections: layerIconCollections,
-    clientBundle: {
-      icons: [...layerIconNames],
-      includeCustomCollections: false,
-      scan: {
-        globInclude: [
-          "**/*.{vue,js,mjs,cjs,ts,jsx,tsx,md,mdc,mdx,yml,yaml}",
-          "**/.navigation.{yml,yaml}",
-        ],
-        globExclude: [
-          ".git",
-          ".nuxt",
-          ".output",
-          ".cache",
-          "node_modules",
-          "dist",
-          "build",
-          "coverage",
-          "test",
-          "tests",
-        ],
-      },
-    },
-  },
-  fonts: {
-    families: publicSansFamilies,
-    providers: {
-      adobe: false,
-      bunny: false,
-      fontshare: false,
-      fontsource: false,
-      google: false,
-      googleicons: false,
-      npm: false,
-    },
-  },
-  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"),
-  },
-  content: {
-    componentPolicy: contentComponentPolicy,
-    // Broken internal links and missing #anchors fail the build instead of
-    // only landing in the validation report.
-    validation: "error",
-    i18n: {
-      translatedSlugs: true,
-    },
-    markdown: {
-      plugins: [
-        [
-          "shiki",
-          {
-            preStyles: false,
-            transformers: [transformerNotationDiff(), transformerNotationHighlight()],
-            themes: { light: lightPlus, dark: darkPlus },
-          },
-        ],
-        ["toc", { depth: 4, searchDepth: 4 }],
-        "summary",
-        ["footnotes", { label: "" }],
-      ],
-      tags: contentComponentTags,
-      anchorLinks: { depth: 4, exclude: [1] },
-    },
-    search: { engine: "minisearch" },
-    sitemap: true,
-    agent: { routes: true, linkHeaders: true, delivery: "static" },
-  },
-  sitemap: {
-    excludeAppSources: ["nuxt:prerender"],
-    // The docs roots prerender as redirects to the first docs page; a sitemap
-    // must not list redirecting URLs.
-    exclude: localeCodes.map((locale) => localizedPath(locale, routeSlugs.docs[locale])),
-  },
-  app: {
-    head: {
-      charset: "utf-8",
-      htmlAttrs: { lang: "en" },
-      viewport: "width=device-width, initial-scale=1",
-      meta: [{ name: "color-scheme", content: "light dark" }],
-    },
-  },
-  hooks: {
-    "components:dirs"(dirs) {
-      const defaultComponentsDir = join(app, "components").replaceAll("\\", "/");
-      const filtered = dirs.filter((entry) => {
-        const path = (typeof entry === "string" ? entry : entry.path).replaceAll("\\", "/");
-        return path !== defaultComponentsDir;
-      });
-      dirs.splice(0, dirs.length, ...filtered);
-    },
-  },
-  nitro: {
-    prerender: {
-      // OG images render through a Resvg worker. Parallel prerenders can
-      // terminate that worker under load and leave otherwise valid pages with
-      // 408/500 social-image routes, so package builds must stay serialized.
-      concurrency: 1,
-      crawlLinks: true,
-      failOnError: true,
-      routes: [
-        "/llms.txt",
-        "/llms-full.txt",
-        "/sitemap.xml",
-        "/robots.txt",
-        // Link page over every authored redirectFrom source; crawling it
-        // materializes the redirect stubs.
-        "/api/_ginko-docs/redirects",
-      ],
-    },
+    customCollections: [{ prefix: 'docs', dir: here('./icons') }],
+    clientBundle: { icons, scan: true, includeCustomCollections: true },
   },
+  // The diagram engine (mermaid + ELK, 462 kB gzip) is loaded only by a page with a ```mermaid block. Left alone, Rolldown
+  // put its small shared module helper into that chunk, the icon runtime on every page imported the helper from there,
+  // and so every page downloaded the engine. A named group of its own keeps the helper out of it (e2e/docs.spec.ts checks).
   vite: {
-    resolve: {
-      dedupe: ["@lupinum/ginko-content", "vue", "vue-router"],
+    build: {
+      rolldownOptions: {
+        output: {
+          codeSplitting: {
+            groups: [{ name: 'mermaid', test: /[\\/]node_modules[\\/](beautiful-mermaid|elkjs|mermaid)[\\/]/, includeDependenciesRecursively: false }],
+          },
+        },
+      },
     },
-    plugins: [tailwindcss()],
   },
-});
+})

package/package.json

@@ -1,103 +1,70 @@
 {
   "name": "@lupinum/ginko-docs",
-  "version": "0.4.0-rc.9",
-  "description": "A Nuxt documentation layer powered by Ginko Content.",
-  "keywords": [
-    "content",
-    "documentation",
-    "i18n",
-    "markdown",
-    "nuxt"
-  ],
-  "homepage": "https://ginko-docs.lupinum.com",
-  "bugs": {
-    "url": "https://github.com/lupinum-dev/ginko-docs/issues"
-  },
+  "version": "0.4.0",
+  "type": "module",
+  "description": "Docs sites on Ginko: a Nuxt layer with navigation, search, blog, changelog and Markdown components.",
   "license": "MIT",
   "author": "Lupinum OG <info@lupinum.com> (https://lupinum.com)",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/lupinum-dev/ginko-docs.git",
-    "directory": "layer"
+    "url": "git+https://github.com/lupinum-dev/ginko.git",
+    "directory": "packages/ginko-docs"
+  },
+  "homepage": "https://github.com/lupinum-dev/ginko/tree/main/packages/ginko-docs#readme",
+  "bugs": {
+    "url": "https://github.com/lupinum-dev/ginko/issues"
   },
-  "bin": {
-    "ginko-docs-favicons": "./runtime/generate-favicons.mjs"
+  "engines": {
+    "node": "^22.18.0 || ^24.0.0 || ^26.0.0"
   },
   "files": [
+    "nuxt.config.ts",
     "app",
-    "i18n",
-    "modules",
-    "public",
-    "runtime",
     "server",
     "shared",
-    "content-collections.ts",
-    "content.js",
-    "content.ts",
-    "components.ts",
-    "icon-bundle.ts",
-    "index.d.ts",
-    "nuxt.config.ts",
-    "tags.ts",
-    "!**/*.test.ts"
+    "icons",
+    "public",
+    "i18n",
+    "dist",
+    "CHANGELOG.md"
   ],
-  "type": "module",
   "main": "./nuxt.config.ts",
   "exports": {
     ".": "./nuxt.config.ts",
-    "./content": {
-      "types": "./content.ts",
-      "import": "./content.js",
-      "default": "./content.js"
+    "./config": {
+      "types": "./dist/config.d.mts",
+      "import": "./dist/config.mjs"
     },
-    "./app-config": "./shared/types/app-config.ts",
-    "./components": "./components.ts",
-    "./nuxt-config": "./shared/types/nuxt-config.ts"
+    "./pages": "./dist/pages.mjs"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@iconify-json/circle-flags": "^1.2.10",
-    "@iconify-json/logos": "^1.2.12",
-    "@iconify-json/lucide": "^1.2.123",
-    "@nuxt/fonts": "^0.14.0",
-    "@nuxt/icon": "^2.5.0",
-    "@nuxt/image": "^2.1.0",
-    "@nuxt/kit": "^4.5.2",
-    "@nuxt/scripts": "^1.3.3",
-    "@nuxtjs/color-mode": "^4.0.1",
-    "@nuxtjs/i18n": "^10.6.0",
-    "@nuxtjs/mcp-toolkit": "0.18.1",
-    "@nuxtjs/robots": "^6.1.4",
-    "@nuxtjs/sitemap": "^8.3.4",
-    "@resvg/resvg-js": "^2.6.2",
-    "@shikijs/transformers": "^4.4.3",
-    "@tailwindcss/vite": "^4.3.3",
-    "@vueuse/core": "^14.4.0",
-    "class-variance-authority": "^0.7.1",
-    "clsx": "^2.1.1",
-    "h3": "1.15.11",
-    "motion-v": "^2.3.0",
-    "nitropack": "^2.13.4",
-    "nuxt-og-image": "^6.7.8",
-    "reka-ui": "^2.10.3",
-    "satori": "^0.19.3",
-    "sharp": "^0.35.3",
-    "shiki": "^4.4.3",
-    "tailwind-merge": "^3.6.0",
-    "tailwindcss": "^4.3.3",
-    "tw-animate-css": "^1.4.0",
-    "zod": "4.4.3"
+    "@comark/vue": "0.7.0",
+    "@iconify-json/lucide": "^1.2.137",
+    "@lupinum/ginko-components": "^0.4.0",
+    "@nuxt/icon": "^2.5.1",
+    "@nuxt/kit": "^4.6.0",
+    "beautiful-mermaid": "^1.1.3",
+    "katex": "^0.18.11"
   },
   "peerDependencies": {
-    "@lupinum/ginko-content": ">=1.0.0-beta.5 <2.0.0",
-    "nuxt": ">=4.5.1 <5",
-    "vue": "^3.5.40",
-    "vue-router": "^5.1.0"
+    "@lupinum/ginko": "^0.4.0",
+    "@lupinum/ginko-content": "^0.4.0",
+    "@lupinum/ginko-i18n": "^0.4.0",
+    "nuxt": "^4.6.0 || ^5.0.0-0",
+    "vue": "^3.5.0"
   },
-  "engines": {
-    "node": "^22.18.0 || ^24.11.0 || >=26.0.0"
+  "devDependencies": {
+    "@lupinum/ginko": "0.4.0",
+    "@lupinum/ginko-content": "0.4.0",
+    "@lupinum/ginko-i18n": "0.4.0",
+    "nuxt": "4.6.0",
+    "unbuild": "3.6.1",
+    "vue": "3.5.43"
   },
-  "scripts": {}
+  "scripts": {
+    "build": "unbuild"
+  }
 }