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

package/app/lib/docsFirst.ts

@@ -0,0 +1,11 @@
+import { useDocs } from '../composables/useDocs'
+
+/**
+ * Leads to the first docs page of the language. A site without any docs page yet gets a 404 instead: a redirect to
+ * `/` would loop, because `/` leads here when the site has no start page.
+ */
+export function toFirstDoc() {
+  const first = useDocs().first.value
+  if (!first) throw createError({ statusCode: 404, statusMessage: 'No docs page yet: add a Markdown file to content/docs/.' })
+  return navigateTo(first, { redirectCode: 302 })
+}

package/app/lib/docsInit.ts

@@ -0,0 +1,18 @@
+// Storage keys and the head scripts of the color-mode switch and the banner. Each component adds its own script
+// (useHead with a fixed key, so two toggles on one page add it once), so they also work inside a site's own layout.
+export const COLOR_KEY = 'docs-color-mode'
+export const bannerKey = (id: string) => `docs-banner:${id}`
+
+// Runs inline in <head>, before first paint. localStorage can throw (private windows, blocked site data); then the
+// page simply follows the system and shows the banner.
+const guarded = (body: string) => `(function(){try{var d=document.documentElement;${body}}catch(e){}})()`
+
+/** Applies the stored light/dark choice (html[data-theme]) before first paint. */
+export function colorInitScript(): string {
+  return guarded(`var m=localStorage.getItem(${JSON.stringify(COLOR_KEY)});if(m==='light'||m==='dark')d.setAttribute('data-theme',m);`)
+}
+
+/** Marks a dismissed banner (html[data-docs-banner-off]) before first paint, so it does not flash. */
+export function bannerInitScript(id: string): string {
+  return guarded(`if(localStorage.getItem(${JSON.stringify(bannerKey(id))})==='1')d.setAttribute('data-docs-banner-off','');`)
+}

package/app/lib/docsNav.ts

@@ -0,0 +1,36 @@
+// Tabs and sections of the side navigation, from the entries' fields. Pure, so the rules have a test.
+import type { NavNode } from '@lupinum/ginko'
+
+export interface DocNode extends NavNode {
+  section?: string
+  badge?: string
+  icon?: string
+  tab?: string
+  children: DocNode[]
+}
+export interface DocTab { title: string; path: string }
+
+export interface DocFields { tab?: string; section?: string; badge?: string; icon?: string }
+
+/**
+ * A root without a tab follows the one before it; a new tab starts without a section; a section runs until the
+ * next one. Children always follow their parent's tab and carry no section.
+ */
+export function enrichNav(tree: NavNode[], fieldsOf: (id: string) => DocFields | undefined): DocNode[] {
+  let running: string | undefined
+  let section: string | undefined
+  const enrich = (node: NavNode, tab: string | undefined, root: boolean): DocNode => {
+    const data = fieldsOf(node.id ?? '')
+    if (root) {
+      if (data?.tab && data.tab !== running) section = undefined
+      running = data?.tab ?? running
+      section = data?.section ?? section
+    }
+    const own = root ? running : tab
+    return {
+      ...node, tab: own, section: root ? section : undefined, badge: data?.badge, icon: data?.icon,
+      children: node.children.map((c) => enrich(c, own, false)),
+    }
+  }
+  return tree.map((n) => enrich(n, undefined, true))
+}

package/app/lib/docsPage.ts

@@ -0,0 +1,44 @@
+// Small pure helpers of the docs page (edit link, Markdown twin, "open in" links), kept apart for tests.
+
+/** Edit link of a page's file. Template placeholders: `{url}`, `{branch}`, `{source}`; default is the GitHub form. */
+export function docsEditUrl(repo: { url: string, branch?: string, editUrl?: string } | undefined, source: string | undefined): string | undefined {
+  if (!repo?.url || !source) return undefined
+  const values: Record<string, string> = { url: repo.url.replace(/\/+$/, ''), branch: repo.branch ?? 'main', source }
+  return (repo.editUrl ?? '{url}/edit/{branch}/{source}').replace(/\{(url|branch|source)\}/g, (_, k: string) => values[k]!)
+}
+
+/**
+ * Edit link of a page stored on the Ginko platform: its form in the Studio, `<platform>/s/<site>/all/<brick>/<id>`.
+ * No platform address (a production build without NUXT_PUBLIC_GINKO_PLATFORM): no link.
+ */
+export function docsStudioUrl(platform: string | undefined, site: string, brick: string, id: string): string | undefined {
+  if (!platform) return undefined
+  return `${platform.replace(/\/+$/, '')}/s/${[site, 'all', brick, id].map(encodeURIComponent).join('/')}`
+}
+
+/**
+ * "Report an issue" for a page. Placeholders: `{url}`, `{title}`, `{page}` (the page's address), URL-encoded except
+ * `{url}`. GitHub repositories get the GitHub form by default; other hosts need `issueUrl`.
+ */
+export function docsIssueUrl(repo: { url: string, issueUrl?: string } | undefined, title: string, page: string): string | undefined {
+  if (!repo?.url) return undefined
+  const url = repo.url.replace(/\/+$/, '')
+  const template = repo.issueUrl ?? (/^https:\/\/github\.com\//.test(url) ? '{url}/issues/new?title={title}&body={page}' : undefined)
+  const values: Record<string, string> = { url, title: encodeURIComponent(title), page: encodeURIComponent(page) }
+  return template?.replace(/\{(url|title|page)\}/g, (_, k: string) => values[k]!)
+}
+
+/** Path of a page's Markdown twin (`/en/docs/x` -> `/en/docs/x.md`, `/` -> `/index.md`). */
+export function docsMarkdownPath(path: string): string {
+  const clean = path.replace(/\/+$/, '')
+  return `${clean || '/index'}.md`
+}
+
+/** A chat the page menu can open the page in (`markdownActions.openIn`). */
+export type DocsAssistant = 'chatgpt' | 'claude'
+
+/** Links that open a chat with a prompt pointing at the page's Markdown. */
+export function docsAskLinks(prompt: string): Record<DocsAssistant, string> {
+  const q = encodeURIComponent(prompt)
+  return { chatgpt: `https://chatgpt.com/?q=${q}`, claude: `https://claude.ai/new?q=${q}` }
+}

package/app/lib/markdownComponents.ts

@@ -0,0 +1,16 @@
+// Math, mermaid and ```md preview examples for the docs layer. GinkoMarkdown shows their source by default (core stays free of KaTeX);
+// a `components` map wins. Both load lazily, so a page without a formula or a diagram never loads KaTeX or mermaid.
+// Math renders on the server (the HTML holds `.katex`); mermaid renders in the browser.
+import { defineAsyncComponent } from 'vue'
+import DocsExample from '../components/DocsExample.vue'
+import DocsTable from '../components/DocsTable.vue'
+
+export const markdownComponents = {
+  math: defineAsyncComponent(async () => {
+    const [, { Math }] = await Promise.all([import('katex/dist/katex.min.css'), import('@comark/vue/plugins/math')])
+    return Math
+  }),
+  mermaid: defineAsyncComponent(() => import('@comark/vue/plugins/mermaid').then((m) => m.Mermaid)),
+  example: DocsExample,
+  table: DocsTable,
+}

package/app/lib/previewToc.ts

@@ -0,0 +1,18 @@
+// The table of contents of a ```md preview: ginko-content keeps only the preview's nodes, so an `::inline-toc`
+// inside a preview gets its links from here. Same shape as the page toc: h2 links with their h3 as children.
+import type { MarkdownToc, TocLink } from '@lupinum/ginko'
+
+type Node = string | [string, Record<string, unknown>, ...unknown[]]
+const textOf = (node: Node): string => (typeof node === 'string' ? node : (node.slice(2) as Node[]).map(textOf).join(''))
+
+export function previewToc(nodes: readonly unknown[]): MarkdownToc {
+  const links: TocLink[] = []
+  for (const node of nodes as Node[]) {
+    if (typeof node === 'string' || (node[0] !== 'h2' && node[0] !== 'h3') || typeof node[1].id !== 'string') continue
+    const link: TocLink = { id: node[1].id, depth: node[0] === 'h2' ? 2 : 3, text: textOf(node).trim() }
+    const parent = links.at(-1)
+    if (link.depth === 3 && parent?.depth === 2) (parent.children ??= []).push(link)
+    else links.push(link)
+  }
+  return { links }
+}

package/dist/config.d.mts

@@ -0,0 +1,232 @@
+import * as _lupinum_ginko from '@lupinum/ginko';
+import { 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[];
+/** `base`: where the docs live, default `/docs` (e.g. `/handbook` inside a larger site). */
+declare function docsCollection(opts: {
+    locales: Locales;
+    label?: string;
+    max?: number;
+    base?: `/${string}`;
+}): _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: { <main>: '/', <l>: '/<l>' }` to `pages`.
+ */
+declare function docsHome(): _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.
+ */
+declare function blogCollections(opts: {
+    locales: Locales;
+    max?: number;
+}): {
+    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: "authors";
+            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: "Tag";
+            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;
+        };
+        /** Shown as a link on the author's name. */
+        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.
+ */
+declare function changelogCollection(opts?: {
+    max?: number;
+}): _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 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 };

package/dist/config.d.ts

@@ -0,0 +1,232 @@
+import * as _lupinum_ginko from '@lupinum/ginko';
+import { 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[];
+/** `base`: where the docs live, default `/docs` (e.g. `/handbook` inside a larger site). */
+declare function docsCollection(opts: {
+    locales: Locales;
+    label?: string;
+    max?: number;
+    base?: `/${string}`;
+}): _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: { <main>: '/', <l>: '/<l>' }` to `pages`.
+ */
+declare function docsHome(): _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.
+ */
+declare function blogCollections(opts: {
+    locales: Locales;
+    max?: number;
+}): {
+    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: "authors";
+            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: "Tag";
+            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;
+        };
+        /** Shown as a link on the author's name. */
+        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.
+ */
+declare function changelogCollection(opts?: {
+    max?: number;
+}): _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 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 };