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

package/dist/config.d.mts

@@ -0,0 +1,252 @@
+import * as _lupinum_ginko from '@lupinum/ginko';
+import { BrickSource, Locale } from '@lupinum/ginko';
+import * as _lupinum_ginko_internal from '@lupinum/ginko/internal';
+export { components } from '@lupinum/ginko-components/registry';
+
+/** The site's locales, main locale first. The same list as `locales` in `defineSite`, as a plain array or a tuple. */
+type Locales = readonly Locale[];
+/**
+ * Where a brick's content comes from: `'files'` (the default) reads Markdown from `content/`, `'platform'` keeps it on
+ * the Ginko platform, where people edit it in Ginko Studio. Unlike the bricks of `@lupinum/ginko/basics`, docs bricks
+ * read files unless they are told otherwise: docs usually live in Git.
+ */
+type DocsSource = BrickSource | 'platform';
+/** `base`: where the docs live, default `/docs` (e.g. `/handbook` inside a larger site). `source`: see `DocsSource`. */
+declare function docsCollection(opts: {
+    locales: Locales;
+    label?: string;
+    max?: number;
+    base?: `/${string}`;
+    source?: DocsSource;
+}): _lupinum_ginko.CollectionBrick<{
+    readonly title: _lupinum_ginko_internal.TextField & Omit<_lupinum_ginko_internal.TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+    readonly description: _lupinum_ginko_internal.LongTextField & {
+        readonly optional: true;
+    };
+    /** Starts a group in the side navigation under this heading; the pages after it belong to it until the next one. */
+    readonly section: _lupinum_ginko_internal.TextField & {
+        readonly optional: true;
+    };
+    /** Nests the entry under another doc in the side navigation and the breadcrumbs. */
+    readonly parent: _lupinum_ginko_internal.RefField & {
+        multiple?: false;
+    } & {
+        readonly to: "docs";
+        readonly optional: true;
+    };
+    /** Section tab above the side navigation; a page without one follows the tab of the page before it. Children follow their parent. */
+    readonly tab: _lupinum_ginko_internal.TextField & {
+        readonly optional: true;
+        readonly max: 30;
+    };
+    /** A short label next to the entry in the side navigation, e.g. "New". */
+    readonly badge: _lupinum_ginko_internal.TextField & {
+        readonly optional: true;
+        readonly max: 20;
+    };
+    /** An icon name such as `lucide:book-open` (any installed Iconify set), shown before the title in the side navigation. */
+    readonly icon: _lupinum_ginko_internal.TextField & {
+        readonly optional: true;
+        readonly max: 60;
+        readonly translate: false;
+    };
+    readonly slug: _lupinum_ginko_internal.SlugField & {
+        readonly from: "title";
+    };
+    readonly body: _lupinum_ginko_internal.MarkdownField & {
+        readonly profile: "page";
+    };
+}, Record<string, `/${string}/[slug]`>>;
+/**
+ * The optional start page: one Markdown file `content/home[.<locale>].md`. The frontmatter fills the hero (title,
+ * description, install command, up to two links) and the feature grid; the text below the frontmatter follows them and
+ * may use every component. Without it, `/` opens the first docs page. Add `home: homePages({ locales })` to `pages`.
+ * `source`: see `DocsSource`.
+ */
+declare function docsHome(opts?: {
+    source?: DocsSource;
+}): _lupinum_ginko.SingleBrick<{
+    readonly title: _lupinum_ginko_internal.TextField & {
+        readonly max: 120;
+    };
+    readonly description: _lupinum_ginko_internal.LongTextField & {
+        readonly optional: true;
+        readonly max: 400;
+    };
+    /** A command shown with a copy button, e.g. `pnpm add @lupinum/ginko`. */
+    readonly install: _lupinum_ginko_internal.TextField & {
+        readonly optional: true;
+        readonly max: 200;
+        readonly translate: false;
+    };
+    /** Buttons under the description; the first one is the main one. */
+    readonly links: _lupinum_ginko_internal.ListField<{
+        readonly label: _lupinum_ginko_internal.TextField & {
+            readonly max: 40;
+        };
+        readonly href: _lupinum_ginko_internal.TextField & {
+            readonly max: 300;
+        };
+    }> & Omit<{
+        readonly itemLabel: "Link";
+        readonly fields: {
+            readonly label: _lupinum_ginko_internal.TextField & {
+                readonly max: 40;
+            };
+            readonly href: _lupinum_ginko_internal.TextField & {
+                readonly max: 300;
+            };
+        };
+        readonly max: 2;
+        readonly default: readonly [];
+    }, "fields">;
+    readonly features: _lupinum_ginko_internal.ListField<{
+        readonly icon: _lupinum_ginko_internal.TextField & {
+            readonly optional: true;
+            readonly max: 60;
+            readonly translate: false;
+        };
+        readonly title: _lupinum_ginko_internal.TextField & {
+            readonly max: 80;
+        };
+        readonly description: _lupinum_ginko_internal.LongTextField & {
+            readonly max: 300;
+        };
+        readonly href: _lupinum_ginko_internal.TextField & {
+            readonly optional: true;
+            readonly max: 300;
+        };
+    }> & Omit<{
+        readonly itemLabel: "Feature";
+        readonly fields: {
+            readonly icon: _lupinum_ginko_internal.TextField & {
+                readonly optional: true;
+                readonly max: 60;
+                readonly translate: false;
+            };
+            readonly title: _lupinum_ginko_internal.TextField & {
+                readonly max: 80;
+            };
+            readonly description: _lupinum_ginko_internal.LongTextField & {
+                readonly max: 300;
+            };
+            readonly href: _lupinum_ginko_internal.TextField & {
+                readonly optional: true;
+                readonly max: 300;
+            };
+        };
+        readonly max: 12;
+        readonly default: readonly [];
+    }, "fields">;
+    readonly body: _lupinum_ginko_internal.MarkdownField & {
+        readonly profile: "page";
+        readonly optional: true;
+    };
+}>;
+/**
+ * The optional blog: `{ posts, authors }`, spread into `bricks` in ginko.config.ts. Posts live at
+ * /blog/<slug> (main locale unprefixed, `/<l>/blog/<slug>` otherwise) and come out newest first.
+ * Authors have no page; a post names them in `authors`. Files: `content/posts/<n>.<name>[.<locale>].md`
+ * and `content/authors/<name>[.<locale>].yml`. Add `blog: blogPages({ locales })` to `pages` as well.
+ * The bricks are `posts()` and `authors()` of `@lupinum/ginko/basics` with the English labels docs sites store.
+ * `source` (both bricks): see `DocsSource`.
+ */
+declare function blogCollections(opts: {
+    locales: Locales;
+    max?: number;
+    source?: DocsSource;
+}): {
+    posts: _lupinum_ginko.CollectionBrick<{
+        readonly title: _lupinum_ginko_internal.TextField & Omit<_lupinum_ginko_internal.TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+            default?: (string | Partial<Record<string, string>>) | undefined;
+        };
+        readonly description: _lupinum_ginko_internal.LongTextField & {
+            readonly optional: true;
+        };
+        readonly date: _lupinum_ginko_internal.DateField & Omit<_lupinum_ginko_internal.DateField, "type" | "label" | "pos" | "retired" | "default"> & {
+            default?: string | undefined;
+        };
+        readonly authors: _lupinum_ginko_internal.RefField & {
+            multiple: true;
+        } & {
+            readonly to: string;
+            readonly optional: true;
+        };
+        readonly image: _lupinum_ginko_internal.ImageField & {
+            readonly optional: true;
+        };
+        readonly tags: _lupinum_ginko_internal.ListField<{
+            readonly tag: _lupinum_ginko_internal.TextField & {
+                readonly max: 40;
+            };
+        }> & Omit<{
+            readonly itemLabel: Record<string, string>;
+            readonly fields: {
+                readonly tag: _lupinum_ginko_internal.TextField & {
+                    readonly max: 40;
+                };
+            };
+            readonly max: 10;
+            readonly optional: true;
+        }, "fields">;
+        readonly slug: _lupinum_ginko_internal.SlugField & {
+            readonly from: "title";
+        };
+        readonly body: _lupinum_ginko_internal.MarkdownField & {
+            readonly profile: "page";
+        };
+    }, Record<string, "/blog/[slug]">>;
+    authors: _lupinum_ginko.CollectionBrick<{
+        readonly name: _lupinum_ginko_internal.TextField & Omit<_lupinum_ginko_internal.TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+            default?: (string | Partial<Record<string, string>>) | undefined;
+        };
+        readonly role: _lupinum_ginko_internal.TextField & {
+            readonly optional: true;
+        };
+        readonly avatar: _lupinum_ginko_internal.ImageField & {
+            readonly optional: true;
+        };
+        readonly url: _lupinum_ginko_internal.TextField & {
+            readonly format: "url";
+            readonly optional: true;
+        };
+    }, undefined>;
+};
+/**
+ * The optional changelog: one page at /changelog with one entry per release, newest first. Entries have no
+ * page of their own, the page links to each by anchor. Files: `content/changelog/<name>[.<locale>].md`
+ * with `version` and `date` in the frontmatter (a dot in the name would read as a language: use `v1-2-0.md`). Add `changelog: changelogPages({ locales })` to `pages` as well.
+ * The brick is `changelog()` of `@lupinum/ginko/basics` with the English labels docs sites store. `source`: see
+ * `DocsSource`.
+ */
+declare function changelogCollection(opts?: {
+    max?: number;
+    source?: DocsSource;
+}): _lupinum_ginko.CollectionBrick<{
+    readonly version: _lupinum_ginko_internal.TextField & {
+        readonly max: 40;
+        readonly translate: false;
+    };
+    readonly date: _lupinum_ginko_internal.DateField & Omit<_lupinum_ginko_internal.DateField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: string | undefined;
+    };
+    readonly body: _lupinum_ginko_internal.MarkdownField & {
+        readonly profile: "page";
+    };
+}, undefined>;
+/** The start page by locale, for `pages` in ginko.config.ts: the main locale at `/`, the others at `/<locale>`. */
+declare const homePages: (opts: {
+    locales: Locales;
+}) => Record<string, "/">;
+/** The list pages by locale, for `pages` in ginko.config.ts: the sitemap and the static build know them from there. */
+declare const blogPages: (opts: {
+    locales: Locales;
+}) => Record<string, "/blog">;
+declare const changelogPages: (opts: {
+    locales: Locales;
+}) => Record<string, "/changelog">;
+
+export { blogCollections, blogPages, changelogCollection, changelogPages, docsCollection, docsHome, homePages };
+export type { DocsSource };

package/dist/config.d.ts

@@ -0,0 +1,252 @@
+import * as _lupinum_ginko from '@lupinum/ginko';
+import { BrickSource, Locale } from '@lupinum/ginko';
+import * as _lupinum_ginko_internal from '@lupinum/ginko/internal';
+export { components } from '@lupinum/ginko-components/registry';
+
+/** The site's locales, main locale first. The same list as `locales` in `defineSite`, as a plain array or a tuple. */
+type Locales = readonly Locale[];
+/**
+ * Where a brick's content comes from: `'files'` (the default) reads Markdown from `content/`, `'platform'` keeps it on
+ * the Ginko platform, where people edit it in Ginko Studio. Unlike the bricks of `@lupinum/ginko/basics`, docs bricks
+ * read files unless they are told otherwise: docs usually live in Git.
+ */
+type DocsSource = BrickSource | 'platform';
+/** `base`: where the docs live, default `/docs` (e.g. `/handbook` inside a larger site). `source`: see `DocsSource`. */
+declare function docsCollection(opts: {
+    locales: Locales;
+    label?: string;
+    max?: number;
+    base?: `/${string}`;
+    source?: DocsSource;
+}): _lupinum_ginko.CollectionBrick<{
+    readonly title: _lupinum_ginko_internal.TextField & Omit<_lupinum_ginko_internal.TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+    readonly description: _lupinum_ginko_internal.LongTextField & {
+        readonly optional: true;
+    };
+    /** Starts a group in the side navigation under this heading; the pages after it belong to it until the next one. */
+    readonly section: _lupinum_ginko_internal.TextField & {
+        readonly optional: true;
+    };
+    /** Nests the entry under another doc in the side navigation and the breadcrumbs. */
+    readonly parent: _lupinum_ginko_internal.RefField & {
+        multiple?: false;
+    } & {
+        readonly to: "docs";
+        readonly optional: true;
+    };
+    /** Section tab above the side navigation; a page without one follows the tab of the page before it. Children follow their parent. */
+    readonly tab: _lupinum_ginko_internal.TextField & {
+        readonly optional: true;
+        readonly max: 30;
+    };
+    /** A short label next to the entry in the side navigation, e.g. "New". */
+    readonly badge: _lupinum_ginko_internal.TextField & {
+        readonly optional: true;
+        readonly max: 20;
+    };
+    /** An icon name such as `lucide:book-open` (any installed Iconify set), shown before the title in the side navigation. */
+    readonly icon: _lupinum_ginko_internal.TextField & {
+        readonly optional: true;
+        readonly max: 60;
+        readonly translate: false;
+    };
+    readonly slug: _lupinum_ginko_internal.SlugField & {
+        readonly from: "title";
+    };
+    readonly body: _lupinum_ginko_internal.MarkdownField & {
+        readonly profile: "page";
+    };
+}, Record<string, `/${string}/[slug]`>>;
+/**
+ * The optional start page: one Markdown file `content/home[.<locale>].md`. The frontmatter fills the hero (title,
+ * description, install command, up to two links) and the feature grid; the text below the frontmatter follows them and
+ * may use every component. Without it, `/` opens the first docs page. Add `home: homePages({ locales })` to `pages`.
+ * `source`: see `DocsSource`.
+ */
+declare function docsHome(opts?: {
+    source?: DocsSource;
+}): _lupinum_ginko.SingleBrick<{
+    readonly title: _lupinum_ginko_internal.TextField & {
+        readonly max: 120;
+    };
+    readonly description: _lupinum_ginko_internal.LongTextField & {
+        readonly optional: true;
+        readonly max: 400;
+    };
+    /** A command shown with a copy button, e.g. `pnpm add @lupinum/ginko`. */
+    readonly install: _lupinum_ginko_internal.TextField & {
+        readonly optional: true;
+        readonly max: 200;
+        readonly translate: false;
+    };
+    /** Buttons under the description; the first one is the main one. */
+    readonly links: _lupinum_ginko_internal.ListField<{
+        readonly label: _lupinum_ginko_internal.TextField & {
+            readonly max: 40;
+        };
+        readonly href: _lupinum_ginko_internal.TextField & {
+            readonly max: 300;
+        };
+    }> & Omit<{
+        readonly itemLabel: "Link";
+        readonly fields: {
+            readonly label: _lupinum_ginko_internal.TextField & {
+                readonly max: 40;
+            };
+            readonly href: _lupinum_ginko_internal.TextField & {
+                readonly max: 300;
+            };
+        };
+        readonly max: 2;
+        readonly default: readonly [];
+    }, "fields">;
+    readonly features: _lupinum_ginko_internal.ListField<{
+        readonly icon: _lupinum_ginko_internal.TextField & {
+            readonly optional: true;
+            readonly max: 60;
+            readonly translate: false;
+        };
+        readonly title: _lupinum_ginko_internal.TextField & {
+            readonly max: 80;
+        };
+        readonly description: _lupinum_ginko_internal.LongTextField & {
+            readonly max: 300;
+        };
+        readonly href: _lupinum_ginko_internal.TextField & {
+            readonly optional: true;
+            readonly max: 300;
+        };
+    }> & Omit<{
+        readonly itemLabel: "Feature";
+        readonly fields: {
+            readonly icon: _lupinum_ginko_internal.TextField & {
+                readonly optional: true;
+                readonly max: 60;
+                readonly translate: false;
+            };
+            readonly title: _lupinum_ginko_internal.TextField & {
+                readonly max: 80;
+            };
+            readonly description: _lupinum_ginko_internal.LongTextField & {
+                readonly max: 300;
+            };
+            readonly href: _lupinum_ginko_internal.TextField & {
+                readonly optional: true;
+                readonly max: 300;
+            };
+        };
+        readonly max: 12;
+        readonly default: readonly [];
+    }, "fields">;
+    readonly body: _lupinum_ginko_internal.MarkdownField & {
+        readonly profile: "page";
+        readonly optional: true;
+    };
+}>;
+/**
+ * The optional blog: `{ posts, authors }`, spread into `bricks` in ginko.config.ts. Posts live at
+ * /blog/<slug> (main locale unprefixed, `/<l>/blog/<slug>` otherwise) and come out newest first.
+ * Authors have no page; a post names them in `authors`. Files: `content/posts/<n>.<name>[.<locale>].md`
+ * and `content/authors/<name>[.<locale>].yml`. Add `blog: blogPages({ locales })` to `pages` as well.
+ * The bricks are `posts()` and `authors()` of `@lupinum/ginko/basics` with the English labels docs sites store.
+ * `source` (both bricks): see `DocsSource`.
+ */
+declare function blogCollections(opts: {
+    locales: Locales;
+    max?: number;
+    source?: DocsSource;
+}): {
+    posts: _lupinum_ginko.CollectionBrick<{
+        readonly title: _lupinum_ginko_internal.TextField & Omit<_lupinum_ginko_internal.TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+            default?: (string | Partial<Record<string, string>>) | undefined;
+        };
+        readonly description: _lupinum_ginko_internal.LongTextField & {
+            readonly optional: true;
+        };
+        readonly date: _lupinum_ginko_internal.DateField & Omit<_lupinum_ginko_internal.DateField, "type" | "label" | "pos" | "retired" | "default"> & {
+            default?: string | undefined;
+        };
+        readonly authors: _lupinum_ginko_internal.RefField & {
+            multiple: true;
+        } & {
+            readonly to: string;
+            readonly optional: true;
+        };
+        readonly image: _lupinum_ginko_internal.ImageField & {
+            readonly optional: true;
+        };
+        readonly tags: _lupinum_ginko_internal.ListField<{
+            readonly tag: _lupinum_ginko_internal.TextField & {
+                readonly max: 40;
+            };
+        }> & Omit<{
+            readonly itemLabel: Record<string, string>;
+            readonly fields: {
+                readonly tag: _lupinum_ginko_internal.TextField & {
+                    readonly max: 40;
+                };
+            };
+            readonly max: 10;
+            readonly optional: true;
+        }, "fields">;
+        readonly slug: _lupinum_ginko_internal.SlugField & {
+            readonly from: "title";
+        };
+        readonly body: _lupinum_ginko_internal.MarkdownField & {
+            readonly profile: "page";
+        };
+    }, Record<string, "/blog/[slug]">>;
+    authors: _lupinum_ginko.CollectionBrick<{
+        readonly name: _lupinum_ginko_internal.TextField & Omit<_lupinum_ginko_internal.TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+            default?: (string | Partial<Record<string, string>>) | undefined;
+        };
+        readonly role: _lupinum_ginko_internal.TextField & {
+            readonly optional: true;
+        };
+        readonly avatar: _lupinum_ginko_internal.ImageField & {
+            readonly optional: true;
+        };
+        readonly url: _lupinum_ginko_internal.TextField & {
+            readonly format: "url";
+            readonly optional: true;
+        };
+    }, undefined>;
+};
+/**
+ * The optional changelog: one page at /changelog with one entry per release, newest first. Entries have no
+ * page of their own, the page links to each by anchor. Files: `content/changelog/<name>[.<locale>].md`
+ * with `version` and `date` in the frontmatter (a dot in the name would read as a language: use `v1-2-0.md`). Add `changelog: changelogPages({ locales })` to `pages` as well.
+ * The brick is `changelog()` of `@lupinum/ginko/basics` with the English labels docs sites store. `source`: see
+ * `DocsSource`.
+ */
+declare function changelogCollection(opts?: {
+    max?: number;
+    source?: DocsSource;
+}): _lupinum_ginko.CollectionBrick<{
+    readonly version: _lupinum_ginko_internal.TextField & {
+        readonly max: 40;
+        readonly translate: false;
+    };
+    readonly date: _lupinum_ginko_internal.DateField & Omit<_lupinum_ginko_internal.DateField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: string | undefined;
+    };
+    readonly body: _lupinum_ginko_internal.MarkdownField & {
+        readonly profile: "page";
+    };
+}, undefined>;
+/** The start page by locale, for `pages` in ginko.config.ts: the main locale at `/`, the others at `/<locale>`. */
+declare const homePages: (opts: {
+    locales: Locales;
+}) => Record<string, "/">;
+/** The list pages by locale, for `pages` in ginko.config.ts: the sitemap and the static build know them from there. */
+declare const blogPages: (opts: {
+    locales: Locales;
+}) => Record<string, "/blog">;
+declare const changelogPages: (opts: {
+    locales: Locales;
+}) => Record<string, "/changelog">;
+
+export { blogCollections, blogPages, changelogCollection, changelogPages, docsCollection, docsHome, homePages };
+export type { DocsSource };

package/dist/config.mjs

@@ -0,0 +1,83 @@
+import { collection, f, single } from '@lupinum/ginko';
+import { authors, posts, changelog } from '@lupinum/ginko/basics';
+import { labelsIn } from '@lupinum/ginko/internal';
+export { components } from '@lupinum/ginko-components/registry';
+
+const BLOG_PATH = "/blog";
+const CHANGELOG_PATH = "/changelog";
+
+const sourceOf = (source = "files") => source === "files" ? { source } : {};
+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.");
+  const address = path;
+  return Object.fromEntries(locales.map((l) => [l, l === main ? path : address === "/" ? `/${l}` : `/${l}${path}`]));
+}
+function docsCollection(opts) {
+  const { locales } = opts;
+  const base = opts.base ?? "/docs";
+  return collection({
+    label: opts.label ?? "Docs",
+    ...sourceOf(opts.source),
+    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(opts = {}) {
+  return single({
+    label: "Start page",
+    ...sourceOf(opts.source),
+    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: labelsIn(posts({ ...sourceOf(opts.source), max: opts.max, route: localized(locales, `${BLOG_PATH}/[slug]`) }), "en"),
+    authors: labelsIn(authors(sourceOf(opts.source)), "en")
+  };
+}
+function changelogCollection(opts = {}) {
+  return labelsIn(changelog({ ...sourceOf(opts.source), max: opts.max }), "en");
+}
+const homePages = (opts) => localized(opts.locales, "/");
+const blogPages = (opts) => localized(opts.locales, BLOG_PATH);
+const changelogPages = (opts) => localized(opts.locales, CHANGELOG_PATH);
+
+export { blogCollections, blogPages, changelogCollection, changelogPages, docsCollection, docsHome, homePages };

package/dist/icons.d.mts

@@ -0,0 +1,38 @@
+import { getIconData } from '@iconify/utils';
+import { NuxtModule } from 'nuxt/schema';
+
+type IconSet = Parameters<typeof getIconData>[0];
+type Entry = [body: string, viewBox: string];
+/**
+ * Code without its comments, so a commented-out icon is not bundled. `//` counts only at a line start or after a space
+ * (not in `https://`). In a .vue file the template keeps its text; only `<!-- -->` and the comments inside `<script>` go.
+ */
+declare const stripComments: (source: string, file?: string) => string;
+/** The icon names in app.config.ts (`icon: 'x'`) or a .vue file (`<Icon name="x">`, `icon="x"`). Comments are ignored. */
+declare const codeIconNames: (source: string, file: string) => string[];
+/**
+ * The icon names a content file names. YAML, JSON and front matter are read whole. In Markdown only the front matter,
+ * the attributes of a component (`:card{icon="x"}`) and the `---` block inside a `::component` count; prose and code are skipped.
+ */
+declare const contentIconNames: (source: string, file: string) => string[];
+/** One icon as [svg body, viewBox], read from the `docs` collection folder or an installed @iconify-json set (looked up from `roots`). */
+declare const readIcon: (name: string, roots: readonly string[], customDir: string, sets?: Map<string, IconSet | undefined>) => Entry | undefined;
+interface CollectOptions {
+    /** The layer's own folder (its `app/` is scanned for literal names, its `icons/` holds the `docs:` logos). */
+    layerRoot: string;
+    /** Root folders of every layer, the site first. Their `content/`, `app.config.ts` and (for the site's own layers) `app/` are scanned. */
+    roots: readonly string[];
+    /** Where to resolve `@iconify-json/<set>` from. */
+    resolveFrom: readonly string[];
+    /** Paths in warnings are shown relative to this folder. */
+    relativeTo: string;
+}
+/** Every icon the layer and the site name, read from the installed sets, plus one warning per name that is not installed. */
+declare const collectIcons: (o: CollectOptions) => {
+    icons: Record<string, Entry>;
+    warnings: string[];
+};
+declare const docsIcons: NuxtModule;
+
+export { codeIconNames, collectIcons, contentIconNames, docsIcons as default, readIcon, stripComments };
+export type { CollectOptions };

package/dist/icons.d.ts

@@ -0,0 +1,38 @@
+import { getIconData } from '@iconify/utils';
+import { NuxtModule } from 'nuxt/schema';
+
+type IconSet = Parameters<typeof getIconData>[0];
+type Entry = [body: string, viewBox: string];
+/**
+ * Code without its comments, so a commented-out icon is not bundled. `//` counts only at a line start or after a space
+ * (not in `https://`). In a .vue file the template keeps its text; only `<!-- -->` and the comments inside `<script>` go.
+ */
+declare const stripComments: (source: string, file?: string) => string;
+/** The icon names in app.config.ts (`icon: 'x'`) or a .vue file (`<Icon name="x">`, `icon="x"`). Comments are ignored. */
+declare const codeIconNames: (source: string, file: string) => string[];
+/**
+ * The icon names a content file names. YAML, JSON and front matter are read whole. In Markdown only the front matter,
+ * the attributes of a component (`:card{icon="x"}`) and the `---` block inside a `::component` count; prose and code are skipped.
+ */
+declare const contentIconNames: (source: string, file: string) => string[];
+/** One icon as [svg body, viewBox], read from the `docs` collection folder or an installed @iconify-json set (looked up from `roots`). */
+declare const readIcon: (name: string, roots: readonly string[], customDir: string, sets?: Map<string, IconSet | undefined>) => Entry | undefined;
+interface CollectOptions {
+    /** The layer's own folder (its `app/` is scanned for literal names, its `icons/` holds the `docs:` logos). */
+    layerRoot: string;
+    /** Root folders of every layer, the site first. Their `content/`, `app.config.ts` and (for the site's own layers) `app/` are scanned. */
+    roots: readonly string[];
+    /** Where to resolve `@iconify-json/<set>` from. */
+    resolveFrom: readonly string[];
+    /** Paths in warnings are shown relative to this folder. */
+    relativeTo: string;
+}
+/** Every icon the layer and the site name, read from the installed sets, plus one warning per name that is not installed. */
+declare const collectIcons: (o: CollectOptions) => {
+    icons: Record<string, Entry>;
+    warnings: string[];
+};
+declare const docsIcons: NuxtModule;
+
+export { codeIconNames, collectIcons, contentIconNames, docsIcons as default, readIcon, stripComments };
+export type { CollectOptions };