create-ginko 0.4.0 → 0.5.0

package/templates/docs/content/docs/8.client.de.md

@@ -0,0 +1,57 @@
+---
+title: Client-Optionen
+slug: client-optionen
+description: Die Klasse Orbit, ihre Optionen mit Standardwerten und die Optionen einer einzelnen Anfrage.
+section: Referenz
+---
+
+## new Orbit(options?)
+
+```ts
+import { Orbit } from '@orbit-example/sdk'
+
+const orbit = new Orbit({ apiKey: process.env.ORBIT_API_KEY, timeout: 10_000 })
+```
+
+Legt einen Client an. Er hält keine Verbindung offen; ein Client pro App genügt und kostet nichts, solange er nichts tut. Jede Option ist optional.
+
+| Option | Typ | Standard | Wirkung |
+|---|---|---|---|
+| `apiKey` | `string` | `process.env.ORBIT_API_KEY` | Der API-Schlüssel. Ohne ihn wirft der Konstruktor `missing_api_key`. Siehe [Authentifizierung]($docs.authentication). |
+| `baseUrl` | `string` | `'https://api.orbit.example.com/v2'` | Die Adresse der API. Ändere sie nur für einen Proxy oder einen Mock-Server in Tests. |
+| `timeout` | `number` | `30_000` | Millisekunden, die ein Versuch auf eine Antwort wartet, bevor er mit `timeout` scheitert. |
+| `maxRetries` | `number` | `2` | Wiederholungen nach einem vorübergehenden Fehler. `0` schaltet sie ab. Siehe [Fehler und Wiederholungen]($docs.errors-and-retries). |
+| `headers` | `Record<string, string>` | `{}` | Header für jede Anfrage, zum Beispiel ein Tracing-Header. |
+| `fetch` | `typeof fetch` | `globalThis.fetch` | Das `fetch`, das der Client nutzt, zum Beispiel ein Mock in Tests. |
+
+## Eigenschaften
+
+| Eigenschaft | Typ | Was sie ist |
+|---|---|---|
+| `orbit.monitors` | `Monitors` | Monitore anlegen, lesen, ändern, pausieren und löschen. Siehe [Monitore]($docs.monitors). |
+| `orbit.incidents` | `Incidents` | Vorfälle lesen und als behoben markieren. Siehe [Vorfälle und Prüfungen]($docs.incidents-and-checks). |
+| `orbit.checks` | `Checks` | Das Ergebnis jeder Prüfung lesen. Siehe [Vorfälle und Prüfungen]($docs.incidents-and-checks). |
+| `orbit.webhooks` | `Webhooks` | Eingehende Webhooks prüfen. Siehe [Webhooks]($docs.webhooks). |
+
+## Optionen einer Anfrage
+
+Jede Methode nimmt als letztes Argument die Optionen einer einzelnen Anfrage. Sie gelten nur für diese Anfrage und gehen den Optionen des Clients vor.
+
+```ts
+await orbit.monitors.get('mon_8f2k1x', { timeout: 5_000, maxRetries: 0 })
+```
+
+| Option | Typ | Wirkung |
+|---|---|---|
+| `timeout` | `number` | Millisekunden für diese Anfrage. |
+| `maxRetries` | `number` | Wiederholungen für diese Anfrage. |
+| `signal` | `AbortSignal` | Bricht die Anfrage ab; die Methode wirft dann den Grund des Signals. |
+| `idempotencyKey` | `string` | Ein eigener Schlüssel statt des erzeugten (nur bei `create()`-Methoden). |
+
+## Typen
+
+Das Paket exportiert den Typ jeder Antwort, damit du ihn in deinem Code benennen kannst:
+
+```ts
+import type { Check, Incident, Monitor, MonitorStatus, Page } from '@orbit-example/sdk'
+```

package/templates/docs/content/docs/8.client.md

@@ -0,0 +1,56 @@
+---
+title: Client options
+description: The Orbit class, its options with their defaults, and the options of a single request.
+section: Reference
+---
+
+## new Orbit(options?)
+
+```ts
+import { Orbit } from '@orbit-example/sdk'
+
+const orbit = new Orbit({ apiKey: process.env.ORBIT_API_KEY, timeout: 10_000 })
+```
+
+Creates a client. It keeps no connection open, so one client per app is enough and costs nothing while idle. Every option is optional.
+
+| Option | Type | Default | What it does |
+|---|---|---|---|
+| `apiKey` | `string` | `process.env.ORBIT_API_KEY` | The API key. Without one, the constructor throws `missing_api_key`. See [Authentication]($docs.authentication). |
+| `baseUrl` | `string` | `'https://api.orbit.example.com/v2'` | The address of the API. Change it only for a proxy or a mock server in tests. |
+| `timeout` | `number` | `30_000` | Milliseconds to wait for an answer before the attempt fails with `timeout`. |
+| `maxRetries` | `number` | `2` | Retries after a temporary error. `0` turns retries off. See [Errors and retries]($docs.errors-and-retries). |
+| `headers` | `Record<string, string>` | `{}` | Headers added to every request, for example a tracing header. |
+| `fetch` | `typeof fetch` | `globalThis.fetch` | The `fetch` to use, for example a mock in tests. |
+
+## Properties
+
+| Property | Type | What it is |
+|---|---|---|
+| `orbit.monitors` | `Monitors` | Create, read, change, pause and delete monitors. See [Monitors]($docs.monitors). |
+| `orbit.incidents` | `Incidents` | Read and resolve incidents. See [Incidents and checks]($docs.incidents-and-checks). |
+| `orbit.checks` | `Checks` | Read the result of each check. See [Incidents and checks]($docs.incidents-and-checks). |
+| `orbit.webhooks` | `Webhooks` | Check incoming webhooks. See [Webhooks]($docs.webhooks). |
+
+## Request options
+
+Every method takes the options of one request as its last argument. They win over the client’s options for that request only.
+
+```ts
+await orbit.monitors.get('mon_8f2k1x', { timeout: 5_000, maxRetries: 0 })
+```
+
+| Option | Type | What it does |
+|---|---|---|
+| `timeout` | `number` | Milliseconds for this request. |
+| `maxRetries` | `number` | Retries for this request. |
+| `signal` | `AbortSignal` | Cancels the request; the method then throws the signal’s reason. |
+| `idempotencyKey` | `string` | Your own key instead of the generated one (`create()` methods only). |
+
+## Types
+
+The package exports the type of every answer, so you can name them in your code:
+
+```ts
+import type { Check, Incident, Monitor, MonitorStatus, Page } from '@orbit-example/sdk'
+```

package/templates/docs/content/docs/9.monitors.de.md

@@ -0,0 +1,96 @@
+---
+title: Monitore
+slug: monitore
+description: Jede Methode von orbit.monitors mit ihren Parametern und ihrem Rückgabewert, und der Typ Monitor.
+badge: Neu
+---
+
+Ein Monitor ist eine Adresse, die Orbit in einem festen Abstand prüft. Alle Methoden hängen an `orbit.monitors`.
+
+## Der Typ Monitor
+
+```ts
+interface Monitor {
+  id: string                 // 'mon_8f2k1x'
+  name: string
+  url: string
+  interval: 30 | 60 | 300 | 900  // Sekunden zwischen zwei Prüfungen
+  regions: Region[]          // 'eu-central' | 'us-east' | 'ap-southeast'
+  expectedStatus: number     // HTTP-Status, der als erreichbar gilt
+  status: MonitorStatus      // 'pending' | 'up' | 'down' | 'paused'
+  createdAt: string          // ISO 8601, UTC
+  lastCheckedAt: string | null
+}
+```
+
+## monitors.create()
+
+```ts
+create(params: CreateMonitor, options?: RequestOptions): Promise<Monitor>
+```
+
+Legt einen Monitor an. Die erste Prüfung läuft innerhalb eines Intervalls.
+
+| Parameter | Typ | Standard | |
+|---|---|---|---|
+| `name` | `string` | Pflicht | Erscheint im Dashboard und in Webhooks. Höchstens 100 Zeichen. |
+| `url` | `string` | Pflicht | Eine `http`- oder `https`-Adresse. |
+| `interval` | `30 \| 60 \| 300 \| 900` | `60` | Sekunden zwischen zwei Prüfungen. |
+| `regions` | `Region[]` | `['eu-central']` | Von wo Orbit prüft. Bei mehreren Regionen öffnet sich ein Vorfall erst, wenn die meisten scheitern. |
+| `expectedStatus` | `number` | `200` | Der HTTP-Status, der als erreichbar gilt. |
+
+Wirft `conflict`, wenn es für dieselbe `url` schon einen Monitor gibt, und `validation_failed` bei einem ungültigen Wert.
+
+## monitors.get()
+
+```ts
+get(id: string, options?: RequestOptions): Promise<Monitor>
+```
+
+Gibt einen Monitor zurück. Wirft `not_found`, wenn es keinen Monitor mit dieser id gibt.
+
+## monitors.list()
+
+```ts
+list(params?: ListMonitors, options?: RequestOptions): PageRequest<Monitor>
+```
+
+Gibt die Monitore zurück, die neuesten zuerst. Mit `await` bekommst du eine Seite, mit `for await` alle (siehe [Paginierung]($docs.pagination)).
+
+| Parameter | Typ | Standard | |
+|---|---|---|---|
+| `status` | `MonitorStatus` | alle | Nur Monitore mit diesem Status. |
+| `limit` | `number` | `20` | Einträge pro Seite, 1 bis 100. |
+| `cursor` | `string` | – | `nextCursor` der vorigen Seite. |
+
+## monitors.update()
+
+```ts
+update(id: string, changes: UpdateMonitor, options?: RequestOptions): Promise<Monitor>
+```
+
+Ändert `name`, `url`, `interval`, `regions` oder `expectedStatus`. Felder, die du weglässt, bleiben, wie sie sind. Gibt den geänderten Monitor zurück.
+
+## monitors.pause()
+
+```ts
+pause(id: string, options?: RequestOptions): Promise<Monitor>
+```
+
+Hält die Prüfungen an, bis du sie wieder startest, zum Beispiel während einer Wartung. Ein pausierter Monitor eröffnet keinen Vorfall. Einen pausierten Monitor erneut zu pausieren ändert nichts. Neu in 2.1.
+
+## monitors.resume()
+
+```ts
+resume(id: string, options?: RequestOptions): Promise<Monitor>
+```
+
+Startet die Prüfungen wieder; bis zur nächsten Prüfung ist der Status `pending`. Neu in 2.1.
+
+## monitors.delete()
+
+```ts
+delete(id: string, options?: RequestOptions): Promise<void>
+```
+
+Löscht den Monitor mit seinen Prüfungen und Vorfällen. Das lässt sich nicht rückgängig machen. Wirft `not_found`, wenn der Monitor schon gelöscht ist.

package/templates/docs/content/docs/9.monitors.md

@@ -0,0 +1,95 @@
+---
+title: Monitors
+description: Every method of orbit.monitors with its parameters and what it returns, and the Monitor type.
+badge: New
+---
+
+A monitor is one address that Orbit checks at a fixed interval. All methods are on `orbit.monitors`.
+
+## The Monitor type
+
+```ts
+interface Monitor {
+  id: string                 // 'mon_8f2k1x'
+  name: string
+  url: string
+  interval: 30 | 60 | 300 | 900  // seconds between checks
+  regions: Region[]          // 'eu-central' | 'us-east' | 'ap-southeast'
+  expectedStatus: number     // HTTP status that counts as up
+  status: MonitorStatus      // 'pending' | 'up' | 'down' | 'paused'
+  createdAt: string          // ISO 8601, UTC
+  lastCheckedAt: string | null
+}
+```
+
+## monitors.create()
+
+```ts
+create(params: CreateMonitor, options?: RequestOptions): Promise<Monitor>
+```
+
+Creates a monitor. The first check runs within one interval.
+
+| Parameter | Type | Default | |
+|---|---|---|---|
+| `name` | `string` | required | Shown in the dashboard and in webhooks. At most 100 characters. |
+| `url` | `string` | required | An `http` or `https` address. |
+| `interval` | `30 \| 60 \| 300 \| 900` | `60` | Seconds between checks. |
+| `regions` | `Region[]` | `['eu-central']` | Where Orbit checks from. More regions mean an incident opens only when most of them fail. |
+| `expectedStatus` | `number` | `200` | The HTTP status that counts as up. |
+
+Throws `conflict` when a monitor for the same `url` exists, and `validation_failed` for a wrong value.
+
+## monitors.get()
+
+```ts
+get(id: string, options?: RequestOptions): Promise<Monitor>
+```
+
+Returns one monitor. Throws `not_found` when there is no monitor with this id.
+
+## monitors.list()
+
+```ts
+list(params?: ListMonitors, options?: RequestOptions): PageRequest<Monitor>
+```
+
+Returns the monitors, newest first. Await it for one page, or use `for await` for all (see [Pagination]($docs.pagination)).
+
+| Parameter | Type | Default | |
+|---|---|---|---|
+| `status` | `MonitorStatus` | all | Only monitors with this status. |
+| `limit` | `number` | `20` | Entries per page, 1 to 100. |
+| `cursor` | `string` | – | `nextCursor` of the page before. |
+
+## monitors.update()
+
+```ts
+update(id: string, changes: UpdateMonitor, options?: RequestOptions): Promise<Monitor>
+```
+
+Changes `name`, `url`, `interval`, `regions` or `expectedStatus`. Fields you leave out stay as they are. Returns the changed monitor.
+
+## monitors.pause()
+
+```ts
+pause(id: string, options?: RequestOptions): Promise<Monitor>
+```
+
+Stops the checks until you resume them, for example during maintenance. A paused monitor opens no incident. Pausing a paused monitor changes nothing. New in 2.1.
+
+## monitors.resume()
+
+```ts
+resume(id: string, options?: RequestOptions): Promise<Monitor>
+```
+
+Starts the checks again; the status is `pending` until the next check. New in 2.1.
+
+## monitors.delete()
+
+```ts
+delete(id: string, options?: RequestOptions): Promise<void>
+```
+
+Deletes the monitor with its checks and incidents. This cannot be undone. Throws `not_found` when the monitor is already gone.

package/templates/docs/content/home.de.md

@@ -0,0 +1,47 @@
+---
+title: Orbit SDK, der TypeScript-Client für die Orbit API
+description: Lege Monitore an, lies Vorfälle und prüfe Webhooks aus Node.js, mit Typen für jede Anfrage und jede Antwort. Orbit SDK wiederholt fehlgeschlagene Anfragen für dich und blättert durch lange Listen.
+links:
+  - label: Schnellstart
+    href: $docs.getting-started
+  - label: API-Referenz
+    href: $docs.client
+features:
+  - title: Authentifizierung
+    description: Lege einen API-Schlüssel an und behalte ihn auf dem Server.
+    href: $docs.authentication
+  - title: Paginierung
+    description: Lies eine Seite oder mit for await jeden Eintrag.
+    href: $docs.pagination
+  - title: Fehler und Wiederholungen
+    description: Welche Fehler der Client wiederholt und welche dein Code behandelt.
+    href: $docs.errors-and-retries
+  - title: Webhooks
+    description: Bekomm eine Anfrage, wenn ein Monitor ausfällt, und prüfe, dass Orbit sie geschickt hat.
+    href: $docs.webhooks
+  - title: API-Referenz
+    description: Der Client, jede Methode mit Parametern und Rückgabetyp und die Fehlercodes.
+    href: $docs.client
+  - title: Änderungen
+    description: Was sich in jeder Version geändert hat, die neueste zuerst.
+    href: $page.changelog
+---
+
+## Deine erste Anfrage
+
+Orbit prüft deine Websites jede Minute und eröffnet einen Vorfall, wenn eine nicht mehr antwortet. Mit einem API-Schlüssel aus dem Orbit-Dashboard legt dieses Skript einen Monitor für eine Kassenseite an:
+
+```ts [check-shop.ts]
+import { Orbit } from '@orbit-example/sdk'
+
+const orbit = new Orbit({ apiKey: process.env.ORBIT_API_KEY })
+
+const monitor = await orbit.monitors.create({
+  name: 'Shop-Kasse',
+  url: 'https://shop.example.com/checkout',
+})
+
+console.log(monitor.id, monitor.status) // mon_8f2k1x pending
+```
+
+Der [Schnellstart]($docs.getting-started) erklärt jede Zeile. Orbit SDK läuft auf Node.js 22 oder neuer und in jeder Laufzeit mit `fetch`.

package/templates/docs/content/home.md

@@ -0,0 +1,54 @@
+---
+title: Orbit SDK, the TypeScript client for the Orbit API
+description: Create monitors, read incidents and verify webhooks from Node.js, with types for every request and answer. Orbit SDK retries failed requests for you and pages through long lists.
+install: npm install @orbit-example/sdk
+links:
+  - label: Get started
+    href: $docs.getting-started
+  - label: API reference
+    href: $docs.client
+features:
+  - icon: lucide:key-round
+    title: Authentication
+    description: Create an API key and keep it on the server.
+    href: $docs.authentication
+  - icon: lucide:list-ordered
+    title: Pagination
+    description: Read one page, or every entry with for await.
+    href: $docs.pagination
+  - icon: lucide:refresh-cw
+    title: Errors and retries
+    description: Which errors the client retries, and which ones your code handles.
+    href: $docs.errors-and-retries
+  - icon: lucide:webhook
+    title: Webhooks
+    description: Get a request when a monitor goes down, and check that Orbit sent it.
+    href: $docs.webhooks
+  - icon: lucide:book-open
+    title: API reference
+    description: The client, every method with its parameters and return type, and the error codes.
+    href: $docs.client
+  - icon: lucide:history
+    title: Changelog
+    description: What changed in each version, newest first.
+    href: $page.changelog
+---
+
+## Your first request
+
+Orbit checks your websites every minute and opens an incident when one stops answering. With an API key from the Orbit dashboard, this script creates a monitor for a checkout page:
+
+```ts [check-shop.ts]
+import { Orbit } from '@orbit-example/sdk'
+
+const orbit = new Orbit({ apiKey: process.env.ORBIT_API_KEY })
+
+const monitor = await orbit.monitors.create({
+  name: 'Shop checkout',
+  url: 'https://shop.example.com/checkout',
+})
+
+console.log(monitor.id, monitor.status) // mon_8f2k1x pending
+```
+
+[Getting started]($docs.getting-started) explains each line. Orbit SDK runs on Node.js 22 or newer and in any runtime with `fetch`.

package/templates/docs/eslint.config.mjs

@@ -0,0 +1,7 @@
+// @ts-check
+import withNuxt from './.nuxt/eslint.config.mjs'
+
+export default withNuxt({
+  // An optional TypeScript prop is `undefined` when not passed; a default for each would only repeat that.
+  rules: { 'vue/require-default-prop': 'off' },
+})

package/templates/docs/ginko.config.ts

@@ -0,0 +1,36 @@
+// Docs template: the documentation of "Orbit SDK", a fictional TypeScript client for the fictional Orbit API, in
+// English and German. The bricks of the docs layer read Markdown from content/, so the site runs without an account.
+// Moving to Ginko Studio later is done together with Lupinum (README, "Move to the Studio").
+import { defineSite } from '@lupinum/ginko'
+import { changelogCollection, changelogPages, components, docsCollection, docsHome, homePages } from '@lupinum/ginko-docs/config'
+import { siteUrl } from './site-url.ts'
+
+// The first language is the main one: its pages have no prefix (/docs/…), the others do (/de/docs/…).
+const locales = ['en', 'de'] as const
+
+export default defineSite({
+  site: 'docs',
+  name: 'Orbit SDK',
+  // `color` fills the share cards: the light --primary of app/assets/css/main.css.
+  seo: { description: 'Documentation of Orbit SDK, the TypeScript client for the Orbit API.', color: '#047857' },
+  url: siteUrl('https://example.com'),
+  timeZone: 'Europe/Berlin',
+  locales,
+  // A link to a missing heading fails `ginko check` and the build (the default is a warning).
+  linkCheck: { anchors: 'error' },
+  currency: 'EUR',
+  pages: {
+    home: homePages({ locales }),
+    changelog: changelogPages({ locales }),
+  },
+  // The Markdown components of the pages (::callout, ::tabs, ::steps …); Ginko checks every tag and prop against them.
+  components,
+  bricks: {
+    // The start page: title, install command, two buttons, the cards and a short text (content/home.md).
+    home: docsHome(),
+    // The pages, in the order of their file numbers; `section` in a page starts a group (content/docs/).
+    docs: docsCollection({ locales }),
+    // One entry per release with version and date, newest first on /changelog (content/changelog/).
+    changelog: changelogCollection(),
+  },
+})

package/templates/docs/gitignore

@@ -0,0 +1,7 @@
+node_modules
+.nuxt
+.output
+.data
+dist
+.env
+*.log

package/templates/docs/i18n/de.json

@@ -0,0 +1,5 @@
+{
+  "docs": {
+    "footer": { "source": "Quellcode", "api": "Orbit API", "imprint": "Impressum", "privacy": "Datenschutz" }
+  }
+}

package/templates/docs/i18n/en.json

@@ -0,0 +1,5 @@
+{
+  "docs": {
+    "footer": { "source": "Source code", "api": "Orbit API", "imprint": "Imprint", "privacy": "Privacy" }
+  }
+}

package/templates/docs/nuxt.config.ts

@@ -0,0 +1,18 @@
+import ginko from './ginko.config.ts'
+import { checkSiteUrl } from './site-url.ts'
+
+// The docs come from the layer @lupinum/ginko-docs: header, search, navigation, language menu, light and dark,
+// footer, the Markdown components, the start page and the changelog. This project brings the content (content/),
+// the texts of its own links (i18n/), the colours (app/assets/css/main.css) and app/app.config.ts.
+export default defineNuxtConfig({
+  compatibilityDate: '2026-10-01',
+  extends: ['@lupinum/ginko-docs'],
+  // nuxt-og-image draws a share card for every page (Ginko passes title, section and `seo.color`).
+  modules: ['@lupinum/ginko/nuxt', '@nuxt/eslint', 'nuxt-og-image'],
+  ginko,
+  css: ['~/assets/css/main.css'],
+  app: { head: { link: [{ rel: 'icon', type: 'image/svg+xml', href: '/favicon.svg' }] } },
+  hooks: {
+    'build:before': () => checkSiteUrl(ginko.url),
+  },
+})

package/templates/docs/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "docs",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "nuxt dev",
+    "build": "nuxt build",
+    "generate": "nuxt generate",
+    "preview": "nuxt preview",
+    "check": "ginko check",
+    "lint": "eslint .",
+    "typecheck": "nuxt typecheck",
+    "postinstall": "nuxt prepare"
+  },
+  "dependencies": {
+    "@lupinum/ginko": "^0.5.0",
+    "@lupinum/ginko-content": "^0.5.0",
+    "@lupinum/ginko-docs": "^0.5.0",
+    "@lupinum/ginko-i18n": "^0.5.0",
+    "@takumi-rs/core": "^2.15.1",
+    "nuxt": "^4.6.1",
+    "nuxt-og-image": "^7.0.3",
+    "vue": "^3.5.43"
+  },
+  "devDependencies": {
+    "@nuxt/eslint": "^1.17.0",
+    "@types/node": "^24.0.0",
+    "eslint": "^10.12.0",
+    "typescript": "^6.0.3",
+    "vue-tsc": "^3.3.13"
+  },
+  "engines": {
+    "node": "^22.22.3 || ^24.15.0 || >=26"
+  },
+  "ginko": {
+    "sampleAnchor": "2026-10-15",
+    "scriptBudget": 160,
+    "features": [
+      "docs"
+    ]
+  }
+}

package/templates/docs/pnpm-workspace.yaml

@@ -0,0 +1,6 @@
+# pnpm only: packages whose install scripts may run. pnpm 11 stops `pnpm install` on any other install script.
+# npm ignores this file.
+allowBuilds:
+  esbuild: true
+  # @nuxt/eslint's import resolver: its install script only checks for a prebuilt binary.
+  unrs-resolver: false

package/templates/docs/public/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32"><circle cx="16" cy="16" r="5" fill="#047857"/><ellipse cx="16" cy="16" rx="13" ry="6.5" fill="none" stroke="#047857" stroke-width="2" transform="rotate(-30 16 16)"/></svg>

package/templates/docs/public/logo-dark.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" width="32" height="32"><circle cx="16" cy="16" r="5" fill="#34d399"/><ellipse cx="16" cy="16" rx="13" ry="6.5" fill="none" stroke="#34d399" stroke-width="2" transform="rotate(-30 16 16)"/></svg>

package/templates/docs/public/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" width="32" height="32"><circle cx="16" cy="16" r="5" fill="#047857"/><ellipse cx="16" cy="16" rx="13" ry="6.5" fill="none" stroke="#047857" stroke-width="2" transform="rotate(-30 16 16)"/></svg>

package/templates/docs/site-url.ts

@@ -0,0 +1,21 @@
+// Synced from templates/_features/docs/site-url.ts by `pnpm templates sync`. Edit the source, not this copy.
+// The site's public address (TEMPLATES T12), read once by ginko.config.ts: NUXT_PUBLIC_SITE_URL, else the production
+// address Vercel sets (VERCEL_PROJECT_PRODUCTION_URL), else `fallback` from ginko.config.ts. Canonical links, the
+// sitemap and share cards start with it, so a Vercel deploy with the example address must not happen.
+
+/** The address to use, without a trailing slash. */
+export function siteUrl(fallback: string): string {
+  const env = process.env.NUXT_PUBLIC_SITE_URL || (process.env.VERCEL_PROJECT_PRODUCTION_URL ? `https://${process.env.VERCEL_PROJECT_PRODUCTION_URL}` : '')
+  return (env || fallback).replace(/\/+$/, '')
+}
+
+/**
+ * Stops a Vercel build that would still use an example.com address and names the variable to set. Any other build
+ * (CI, a local build, another host) only prints a warning, so a fresh copy of the template builds as it is.
+ */
+export function checkSiteUrl(url: string): void {
+  if (!/^https?:\/\/([^/]+\.)?example\.com(\/|$)/.test(url)) return
+  const message = `The site address is still ${url}. Set NUXT_PUBLIC_SITE_URL to the address of the live site (for example https://www.my-site.com) in the build environment, or change \`url\` in ginko.config.ts.`
+  if (process.env.VERCEL) throw new Error(message)
+  console.warn(`Warning: ${message} Canonical links, the sitemap and share cards use this address.`)
+}

package/templates/docs/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "files": [],
+  "references": [
+    { "path": "./.nuxt/tsconfig.app.json" },
+    { "path": "./.nuxt/tsconfig.server.json" },
+    { "path": "./.nuxt/tsconfig.shared.json" },
+    { "path": "./.nuxt/tsconfig.node.json" }
+  ]
+}

package/templates/docs.json

@@ -0,0 +1,7 @@
+{
+  "locales": [
+    "en",
+    "de"
+  ],
+  "shift": {}
+}

package/templates/events/.env.example

@@ -0,0 +1,8 @@
+# Copy this file to .env for `nuxt dev` and `nuxt preview`, and set the same variables where the site runs.
+
+# Signs the URLs of the share cards (nuxt-og-image). Any 32 or more random characters (`openssl rand -hex 32`).
+NUXT_APP_SECRET=
+
+# The address of the live site, for canonical links, the sitemap and share cards. A build on Vercel stops
+# while it is still example.com; other builds print a warning. On Vercel, the production address is used when this is empty.
+NUXT_PUBLIC_SITE_URL=

package/templates/events/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+# Lint, type-check and build on every push and pull request.
+# To use pnpm instead of npm: commit a pnpm-lock.yaml, add `- run: corepack enable pnpm` before the install step,
+# and replace `npm install` with `pnpm install --frozen-lockfile` and `npm run` with `pnpm run`.
+name: ci
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6
+        with:
+          node-version: 24
+      - run: npm install
+      - run: npm run lint
+      - run: npm run typecheck
+      - run: npm run build