create-ginko 0.4.0 → 0.5.0

package/templates/starter/DESIGN.md

@@ -0,0 +1,197 @@
+# Design system
+
+The rules behind this site's look. Read them before you change colours, type or components, so the site stays
+consistent and accessible (WCAG 2.2 AA, light and dark). The same system runs every Ginko template; only the accent
+and the fonts differ.
+
+## Principles
+
+- A quiet, neutral base; your content and photos carry the character. One accent colour.
+- Hierarchy from size and weight, not colour. One primary button per view. No gradients, glass, blur or decorative
+  shadows. Separate with a 1px border or a background, never both.
+- Phone first. Every page works at 320 px wide with no horizontal scroll; touch targets are at least 44 px.
+- Only tokens. Tailwind's default palette, type scale, radii and shadows are switched off, so `bg-red-500` or
+  `text-2xl` do nothing. A new value is a new token in the CSS and a row in this file, in the same change.
+
+## Where things live
+
+| What | File |
+|---|---|
+| Your accent and fonts | `app/assets/css/main.css` (`--brand`, `--brand-foreground`, `--font-body`, optional `--font-heading`); the light accent again as `seo.color` in `ginko.config.ts` (share cards) |
+| Neutral colours, type scale, spacing, radii, shadow, focus, motion | `app/assets/css/tokens.css` (shared by all templates; do not edit) |
+| Name, logo, navigation, footer links, profiles | `app/app.config.ts` |
+| Components | `app/components/ui/` (shadcn-vue), `app/components/site/`, `app/components/block/` |
+
+`tokens.css` and the components are copied from the Ginko repository (`templates/_features/`). You can change them in
+your own site; in the Ginko repository, change the source there instead.
+
+## Colours
+
+shadcn names, so shadcn-vue components work unchanged. Light / dark:
+
+| Token | Light | Dark | Use |
+|---|---|---|---|
+| `--background` | `#ffffff` | `#0b0b0c` | page |
+| `--foreground` | `#18181b` | `#f4f4f5` | text (17.7:1 / 17.0:1) |
+| `--muted` | `#f4f4f5` | `#18181b` | footer, notice bar, image placeholders |
+| `--muted-foreground` | `#52525b` | `#a1a1aa` | secondary text (7.7:1 / 7.9:1) |
+| `--accent` | `#f4f4f5` | `#27272a` | hover of quiet controls |
+| `--border` | `#e4e4e7` | `#27272a` | dividers, never text |
+| `--input` | `#8a8a93` | `#71717a` | borders of controls (3:1 non-text) |
+| `--primary` | `--brand` | `--brand` | primary button, links in text, focus ring |
+| `--primary-foreground` | `--brand-foreground` | `--brand-foreground` | text on the accent |
+| `--ring` | = `--primary` | = `--primary` | focus |
+| `--success` / `--warning` / `--destructive` | `#15803d` / `#a16207` / `#b42318` | `#4ade80` / `#facc15` / `#f87171` | status text, always with an icon or a word |
+| `--scrim` | zinc-950 at 60 % | black at 72 % | behind the nav sheet and dialogs; the lightbox is opaque dark `--background`, so no page text shows behind a photo |
+
+**Your accent.** `--brand` and `--brand-foreground` in `main.css`, once in `:root` (light) and once in `.dark`. The
+values and their contrast are written next to them. Rules: text on the accent ≥ 4.5:1; the accent on the background
+≥ 4.5:1 in both modes, because links in text use it; in dark mode use a light tint of the accent. Set the light value
+as `seo.color` in `ginko.config.ts` too: it fills the share cards. The accents of the Ginko templates:
+
+| Template | Light | Text on it | Dark | Text on it | Headings |
+|---|---|---|---|---|---|
+| starter | `#18181b` | `#ffffff` | `#f4f4f5` | `#18181b` | Inter |
+| blog | `#4f46e5` | `#ffffff` | `#a5b4fc` | `#1e1b4b` | Inter |
+| portfolio | `#1c1917` | `#ffffff` | `#f5f5f4` | `#1c1917` | Instrument Serif, `text-h3` 22–28 px |
+| company | `#0369a1` | `#ffffff` | `#7dd3fc` | `#082f49` | Inter |
+| saas | `#6d28d9` | `#ffffff` | `#c4b5fd` | `#2e1065` | Inter |
+| restaurant | `#c2410c` | `#ffffff` | `#fdba74` | `#431407` | Fraunces |
+| local-business | `#0f766e` | `#ffffff` | `#5eead4` | `#042f2e` | Inter |
+| nonprofit | `#15803d` | `#ffffff` | `#86efac` | `#052e16` | Inter |
+| events | `#be123c` | `#ffffff` | `#fda4af` | `#4c0519` | Inter |
+
+`.surface-primary` turns a band into the accent colour and swaps text, buttons and the focus ring, so everything in
+it keeps its contrast (used by `BlockCta`). A template may give the band its own colour with `--brand-surface` and
+`--brand-surface-foreground` in `main.css` (text on it ≥ 4.5:1). Use it in `.dark` when the dark accent is a light
+tint: a full-width band of it is the loudest surface on a near-black page. nonprofit: `#14532d` with `#f0fdf4`
+(8.7:1) in dark mode; buttons and links keep `#86efac`.
+
+Dark mode: `@nuxtjs/color-mode` puts `.dark` on `<html>` (first visit: the system setting); `dark:` utilities and
+`color-scheme` follow it. Printing always uses the light neutrals (paper is white). The navigation, notices, controls and closing band are left
+out (`print:hidden`); the footer prints only the name, address, email and phone, so any page prints as its content
+with whose it is.
+
+## Type
+
+Inter (variable, latin and latin-ext) through `@nuxt/fonts`, served from the site itself. A display face for headings
+is optional (`--font-heading`); a narrow one may set `--text-h3` larger in an `@theme` block of `main.css`, so titles
+still lead the body text (the portfolio). Right-to-left languages add their own face on `:lang(…)`.
+
+| Utility | Size | Line height |
+|---|---|---|
+| `text-h1` | `clamp(2.25rem, 1.5rem + 3.2vw, 4rem)` | 1.05, tracking −0.025em; one per page |
+| `text-h2` | `clamp(1.75rem, 1.35rem + 1.7vw, 2.75rem)` | 1.1, tracking −0.02em; sentences such as the `BlockCta` title |
+| `text-h3` | `clamp(1.2rem, 1.1rem + 0.45vw, 1.45rem)` | 1.3; section labels and `##` in Markdown |
+| `text-lead` | `clamp(1.125rem, 1.06rem + 0.3vw, 1.3125rem)` | 1.5 |
+| `text-body` | `1.0625rem` | 1.6 |
+| `text-small` | `0.9375rem` | 1.5 |
+| `text-xs` | `0.8125rem` | 1.4; the smallest size |
+
+Headings balance their lines and hyphenate (the page sets `lang`). Prices, times and dates use `tabular-nums`
+(`<time>` gets it by default). Text runs at most `max-w-prose` (43.5rem, about 65 characters of body text; in rem so the line width does not
+change when the web font replaces its fallback).
+
+## Space, size, radius, shadow
+
+| Token | Value | Use |
+|---|---|---|
+| `pt-section` (`--spacing-section`) | `clamp(3.5rem, 2.25rem + 5.5vw, 7rem)` | space above each section |
+| `px-gutter` (`--spacing-gutter`) | `clamp(1rem, 0.5rem + 2.4vw, 2rem)` | page edges (16 px on phones) |
+| `max-w-page` | `76rem` | page width |
+| `max-w-prose` | `43.5rem` | text width (about 65 characters) |
+| `rounded-md` (`--radius`) | `0.625rem` | buttons, controls |
+| `rounded-block` | `1rem` | images, cards, the CTA band |
+| `shadow-overlay` | one soft shadow | nav sheet, dialog, menus; nothing else |
+
+Tailwind's spacing steps (`p-4`, `gap-6`) stay available.
+
+## Focus and motion
+
+Every interactive element shows a 2px ring in `--ring`, 3px away (`:focus-visible` in `tokens.css`); components do
+not draw their own. Motion only for a change of state: 150 ms for colours, 200–300 ms for the sheet, accordion and
+dialog, `ease-out`. With `prefers-reduced-motion`, transitions and animations are switched off.
+
+## Components
+
+`app/components/ui/`: shadcn-vue components, copied with the shadcn-vue CLI and trimmed to these:
+
+| Component | Variants |
+|---|---|
+| `Button` | shadcn-vue's names: `default` (the main action), `outline`, `secondary`, `destructive`, `ghost`, `link`; sizes `default` (44 px), `sm` (36 px with a mouse, 44 px on touch), `lg` (48 px), `icon` (44 px), `icon-sm`, `icon-lg` |
+| `Sheet` | `side="start"` (default) or `end`: logical sides, so it opens from the right in right-to-left languages |
+| `Accordion` | as in shadcn-vue, on these tokens; only in templates with questions and answers (`BlockFaq`) |
+
+Nothing else until a feature needs it. To add one: `npx shadcn-vue@latest add <name>`, then:
+
+1. Change `import { cn } from 'cn'` to `import { cn } from '@/lib/utils'` and remove the `cn` package the CLI adds.
+2. Replace Tailwind default classes (`text-sm`, `shadow-lg`, `rounded-lg`, `bg-black/80`) with the tokens above. In
+   the browser they give no error, they just do nothing.
+3. Run `npm run lint` and `npm run typecheck`, and look at the component in light and dark. Lint fails on every class
+   the theme does not have (`eslint.tailwind.mjs`, which reads `main.css`). A class that is on purpose not Tailwind
+   (a hook for plain CSS) goes into the explicit list at the top of that file, with a comment saying why.
+
+Icons come from `@lucide/vue` (what the CLI installs; `lucide-vue-next` is deprecated).
+
+`cn` (`app/lib/utils.ts`) joins classes and resolves conflicts with tailwind-merge, as in shadcn: a
+`class="text-small"` on a component that sets `text-h3` wins. tailwind-merge is configured for the theme of
+tokens.css (`text-small`, `p-gutter`, `max-w-page`, `rounded-block`…); a new token in `@theme` gets its line there too.
+
+`app/components/site/`: `SiteHeader` (name or logo, up to 6 links, language switch, theme toggle; the links move into
+`SiteNavSheet` below `md`, or below `xl` when there are more than 4), `SiteFooter`, `SiteSkipLink`, `SiteLogo`,
+`SiteNavLink`, `SiteThemeToggle`, `SiteLanguageSwitch` (the same page in each language), `SiteNotice` (up to two
+notices above the header).
+
+`app/components/block/` and two more:
+
+| Component | Use |
+|---|---|
+| `BlockHero` | home only: the page's h1, a lead, one primary and one secondary action, an optional photo (16:9) |
+| `BlockPageHeader` | every other page: h1, lead, optional meta line |
+| `BlockSection` | a short label as heading (`text-h3`, the size of a Markdown `##`), optional lead, content; from `lg` heading 4 and content 8 of 12 columns, or full width |
+| `BlockCards` | 2–4 per row; the whole card is one link; photos 3:2 |
+| `BlockFeatures` | 2–6 items divided by lines, no cards |
+| `BlockCta` | a closing band on the accent; one per page, not on legal, contact or error pages |
+| `BlockEmpty` | an empty list: what to add, and where (`content/…`) |
+| `ProseBody` | a Markdown body (headings start at `##`); with `@lupinum/ginko-components` installed, its components too |
+| `InitialsAvatar` | a person without a photo: initials, never a stock face |
+
+## Page patterns
+
+- Home starts with `BlockHero`; other pages with `BlockPageHeader`.
+- Section titles are short labels without a full stop; hero and CTA titles are sentences.
+- Lists show the date or status a visitor needs, in tabular numbers.
+- Every image has a real width, height and alt text, and a fixed ratio per block, so nothing jumps while loading.
+- Right-to-left: only logical utilities (`ms-`, `pe-`, `start-`, `text-start`); arrows get `rtl:-scale-x-100`.
+
+## Patterns of the features
+
+In templates that have these features (`templates/_features/` in the Ginko repository):
+
+- **Open now** (`hours`): `HoursToday` says open or closed in words, the dot only repeats it. It stands above the h1 on
+  the home page, under the call and email buttons on a page for getting in touch, and at the top of the footer's
+  contact column on every page (`app/components/site/FooterStatus.vue`). Opening times never break inside a span:
+  a narrow screen breaks between "11:30–14:00 and" and "17:30–22:00".
+- **Where** (home): one quiet line under the hero's actions: a pin icon, the address, and an "Open in maps" link
+  (`text-small`, muted, the link at least 44 px tall). No embedded map.
+- **Getting in touch** (a reservations page): right under `BlockPageHeader`, one primary button (call) and one
+  secondary (email), `size="lg"`, full width below `sm`; the open-now line under them; text and the opening hours
+  below.
+- **A long list** (the menu): under the header, a row of links to its sections (`text-small`, accent, at least 44 px
+  tall), so a phone reaches the desserts in one tap; each section has an `id`.
+- **Reading** (`blog`): a post's date and reading time in one muted line under the lead, the authors with their
+  initials under it; tags as quiet bordered links (at least 44 px tall) after the text; the older and the newer post
+  as two bordered links side by side (stacked on phones). In a Markdown text, a photo's caption is an emphasised line
+  right under the image (`![Alt text](./photo.jpg)`, then `*The caption*` on the next line); long lines in code
+  blocks wrap.
+- **Photos on phones** (`gallery`): one column at full width, each photo 3:2; justified rows from `sm`.
+
+## Do and don't
+
+| Do | Don't |
+|---|---|
+| `text-muted-foreground` for secondary text | pick a grey by hand |
+| add a token to the CSS and this file | arbitrary values (`p-[13px]`, `bg-[#…]`) |
+| one primary button per view, one CTA band per page | the accent behind body text |
+| status with a word or an icon, plus colour | colour alone |
+| initials for people without a photo | stock faces for named people |

package/templates/starter/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2026 Lupinum OG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/templates/starter/MEDIA.md

@@ -0,0 +1,11 @@
+# Media
+
+Photos and other media in this template, with their source and license. The code is MIT (see LICENSE); media keep
+their own license.
+
+This template ships no photos: the home page hero works without one, and pages show an image only when you add one
+(`image:` in a page's frontmatter). When you add photos, list each here.
+
+| File | Source | License |
+|---|---|---|
+| `.github/screenshots/home-light.png`, `home-dark.png` | screenshots of this template | MIT, like the code |

package/templates/starter/README.md

@@ -0,0 +1,199 @@
+# Starter
+
+A plain, complete website to start from: a home page, free pages (About, Contact), short notices, legal texts and
+contact details, in English and German, with light and dark mode. Built with [Nuxt](https://nuxt.com) and
+[Ginko](https://github.com/lupinum-dev/ginko). All content is Markdown in `content/`; the site needs no account and
+no database.
+
+| Light | Dark |
+|---|---|
+| ![The starter's home page in light mode](.github/screenshots/home-light.png) | ![The starter's home page in dark mode](.github/screenshots/home-dark.png) |
+
+## Quick start
+
+```bash
+npm create ginko@latest my-site -- --template starter
+```
+
+This copies the template into `my-site`, keeps the languages you choose (`--locales en` for English only,
+`--locales de,en` for German first), moves the sample dates to this week, sets the site id and writes a `.env` with a
+new `NUXT_APP_SECRET`. Then:
+
+```bash
+cd my-site
+npm install
+npm run dev
+```
+
+Or copy the folder as it is, with both languages, through Nuxt's own command:
+
+```bash
+npm create nuxt@latest my-site -- -t github:lupinum-dev/ginko/templates/starter#release
+```
+
+Copy `.env.example` to `.env` and fill in `NUXT_APP_SECRET` (see below). The `#release` branch follows the latest
+Ginko release, so both commands give you the same files.
+
+## Deploy
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flupinum-dev%2Fginko%2Ftree%2Frelease%2Ftemplates%2Fstarter&env=NUXT_APP_SECRET&envDescription=Signs%20the%20share%20card%20URLs.%20Any%2032%20or%20more%20random%20characters.)
+
+Any host that runs Node works: `npm run build` writes a server to `.output/`, started with
+`node .output/server/index.mjs`. Set these variables where the site runs:
+
+| Variable | What |
+|---|---|
+| `NUXT_APP_SECRET` | Signs the URLs of the share cards. 32 or more random characters (`openssl rand -hex 32`). |
+| `NUXT_PUBLIC_SITE_URL` | The address of the live site, for example `https://www.my-site.com`. On Vercel the production address is used when this is not set. |
+
+A build on Vercel stops with a message while the address is still `example.com`, so search engines never see wrong
+links. Other builds (CI, your computer) only print a warning.
+
+This site can also be built as static files (`npm run generate`, output in `.output/public/`). Then a notice leaves
+the site only with the next build after its end date: add a daily rebuild (for example a Vercel cron job or a
+scheduled GitHub Action).
+
+## Develop, build, preview
+
+| Command | What |
+|---|---|
+| `npm run dev` | the site with live reload on http://localhost:3000 |
+| `npm run check` | Checks the content files in a few seconds: missing or wrong fields, dates, links between pages and files in `public/`. Each problem names the file and the field. |
+| `npm run build` | the production build in `.output/` |
+| `npm run preview` | runs that build locally |
+| `npm run generate` | static files instead of a server |
+| `npm run lint` | ESLint |
+| `npm run typecheck` | TypeScript and Vue types |
+
+`.github/workflows/ci.yml` runs lint, typecheck and build on every push. It needs no settings.
+
+## Edit content
+
+Every text is a Markdown file. The main language has no suffix (`about.md`); a translation adds the language code
+(`about.de.md`). The number at the start of a file name sets the order. After each change, run `npm run check`.
+
+Files point to other entries by id: the folder and the file name without number and language, so
+`content/pages/1.about.md` is `pages/about`. The `slug` is only the address on the site: renaming a file breaks the
+references to it (`nav` and `footer` in `app/app.config.ts`), changing the `slug` does not. Write dates as `2026-10-24`.
+
+| On the site | File |
+|---|---|
+| Home page: title, lead, text | `content/home.md`, `content/home.de.md` |
+| Pages (About, Contact, …) | `content/pages/<n>.<name>.md`; the German file sets its own address with `slug:` |
+| Notices above the header | `content/notices/<n>.<name>.md`: `text` (at most 140 characters; in quotes when it contains a colon) and `until` (the last day it shows, like `2026-12-31`; without it the notice stays until you delete the file). A translation has only `text`. |
+| Name, address, email, phone (footer, search engines) | `content/site.md` |
+| Privacy policy, terms, imprint | `content/legal/` (placeholders: replace them before you go live) |
+| Site name, description for search engines | `ginko.config.ts` (`name`, `seo.description`) |
+| Menu, the line under the name in the footer, footer links, profiles elsewhere | `app/app.config.ts` |
+| Texts of buttons and labels | `i18n/site/<language>.json`; to change one, set it under `"site"` in `i18n/<language>.json` |
+
+Notices show newest first: give a new notice a smaller number than the others (`0.` works, and numbers may have
+gaps), so older notices keep theirs. At most two show at once.
+
+## Make it yours
+
+The sample is a fictional translator, Klara Brenner in Freiburg: a home page, an About and a Contact page, a notice and
+legal texts, in English and German. Make it yours in three steps:
+
+1. Write your own texts. They are Markdown files in `content/`; the home page is `content/home.md`. The contact
+   details on the Contact page come from `content/site.md`, which also fills the footer and the imprint: change them
+   there, once. The site has no contact form (see "Add a contact form").
+2. Set the name in `ginko.config.ts` and the menu in `app/app.config.ts`.
+3. Pick your colour and fonts in `app/assets/css/main.css`.
+
+Details for each step:
+
+- **Name and menu.** `name` in `ginko.config.ts` (header, footer, share cards, search engines). The sample name
+  (Klara Brenner) also appears in the About summaries and `content/site.md`; change those too. `nav` in `app/app.config.ts` lists pages by id
+  (`pages/about` is `content/pages/1.about.md`), at most six.
+- **Logo.** Put the file in `public/` and set `logo: { src: '/logo.svg', width: 120, height: 32 }` in
+  `app/app.config.ts`. Without it, the header shows the name. `shortName` replaces a long name on phones.
+- **Colour.** `--brand` and `--brand-foreground` in `app/assets/css/main.css`, once for light and once for dark
+  (`.dark`), and the light value as `seo.color` in `ginko.config.ts` (the background of the share cards). Text on the
+  colour needs a contrast of at least 4.5:1 in both modes; check each pair with a contrast checker (for example
+  webaim.org/resources/contrastchecker). `DESIGN.md` has the rules and the colours of the other templates.
+- **Fonts.** `--font-body` (and optionally `--font-heading`) in `main.css`. `@nuxt/fonts` downloads the font at build
+  time and serves it from your site.
+- **Organisation type.** `organization` in `app/app.config.ts` (`Organization`, `LocalBusiness` or `NGO`) tells
+  search engines what you are; address and contact come from `content/site.md`.
+
+`DESIGN.md` explains the tokens and components. The parts in `app/components/ui/` are
+[shadcn-vue](https://www.shadcn-vue.com) components.
+
+## Add a page
+
+**A text page:** add `content/pages/3.services.md` with a `title`, an optional `summary` and the text below the
+frontmatter. It appears at `/services` (`/de/<slug>` for the German file). Add `{ entry: 'pages/services' }` to `nav`
+in `app/app.config.ts` to put it in the menu.
+
+**A page with its own layout:** add a Vue file in `app/pages/`, for example `app/pages/team.vue`. It answers at
+`/team` and `/de/team`. Start it with `<BlockPageHeader>` and call `usePageSeo()`, like `app/pages/[...slug].vue`, and
+register it in `ginko.config.ts` under `pages` (`team: localized('/team')`), so `useGinkoPath()('team')` links to it.
+
+For a German address of its own, add `definePageMeta({ i18n: { paths: { de: '/mannschaft' } } })` to the page (the
+path without `/de`; the page then answers at `/de/mannschaft`) and register both addresses:
+`team: { en: '/team', de: '/de/mannschaft' }`.
+
+## Add or remove a language
+
+The languages are the `locales` list in `app/routes.ts`; the first is the main language, whose addresses have no
+prefix.
+
+- **Remove one:** delete it from `locales`, then delete its files (`*.de.md`, `i18n/de.json`). Or start fresh with
+  `npm create ginko@latest my-site -- --template starter --locales en`.
+- **Add one** (for example French): add `'fr'` to `locales`, add `content/**/*.fr.md` translations (pages without one
+  stay in the main language) and `i18n/site/fr.json` with the texts of `i18n/site/en.json` translated.
+
+## Use Markdown components
+
+Page texts are plain Markdown. [`@lupinum/ginko-components`](https://www.npmjs.com/package/@lupinum/ginko-components)
+adds callouts, tabs, cards and more (`::callout` in a text). It is not installed, because it adds about 50 kB of
+JavaScript to every page. To add it: `npm install @lupinum/ginko-components`, add `'@lupinum/ginko-components'` to
+`modules` in `nuxt.config.ts`, and `components` (from `@lupinum/ginko-components/registry`) to `defineSite` in
+`ginko.config.ts`.
+
+## Add a contact form
+
+The site sends no data to other companies, so it has no form. To add one, link to a form service of your choice
+from the contact page (Markdown link), or embed its form in a Vue page. Name the service in your privacy policy.
+
+## Remove a feature
+
+| Feature | Delete |
+|---|---|
+| Notices | `content/notices/`, the `notices` brick in `ginko.config.ts`, `<SiteNotice />` in `app/layouts/default.vue`, `app/components/site/Notice.vue` |
+| A legal text | its files in `content/legal/` |
+| German | see "Add or remove a language" |
+| Dark mode | `<SiteThemeToggle />` in `app/components/site/Header.vue`, `app/components/site/ThemeToggle.vue`, and `@nuxtjs/color-mode` with its `colorMode` options in `nuxt.config.ts` and `package.json` |
+| Share cards | `nuxt-og-image` and `@takumi-rs/core` in `nuxt.config.ts` and `package.json`; then `NUXT_APP_SECRET` is not needed |
+
+## Before you deploy
+
+- [ ] `NUXT_PUBLIC_SITE_URL` (or `url` in `ginko.config.ts`) is your real address.
+- [ ] `NUXT_APP_SECRET` is set where the site runs.
+- [ ] The placeholders in `content/legal/` are replaced by your own texts, and the ones you do not need are deleted.
+- [ ] `content/site.md` and the contact page show your real contact details.
+- [ ] The sample phone numbers and emails are replaced: they reach nobody (the numbers start their local part
+  with 0, the emails end in .example), so a forgotten one fails quietly.
+- [ ] Every photo you added has alt text and a source in `MEDIA.md`.
+
+## Move to the Studio
+
+Ginko Studio is Lupinum's hosted editor: owners change texts and notices on their phone, without Git. It is open by
+invitation, and Lupinum moves your content with you. The site stays the same code: each brick in
+`ginko.config.ts` loses its `source: 'files'`, and its content then comes from the Studio. Until then, everything here
+works without it. Ask at [lupinum.com](https://lupinum.com).
+
+## Updating
+
+Move all Ginko packages to the same version in one step:
+
+```bash
+npm install @lupinum/ginko@latest @lupinum/ginko-content@latest @lupinum/ginko-i18n@latest
+```
+
+The release notes list "Template files changed": compare those files with yours if you want the changes.
+
+## License
+
+Code: MIT (see `LICENSE`). Media: see `MEDIA.md`.

package/templates/starter/app/app.config.ts

@@ -0,0 +1,21 @@
+import type { SiteAppConfig } from './composables/useSiteAppConfig'
+
+// The brand and navigation of the site. The name is `name` in ginko.config.ts; colours and fonts are in
+// app/assets/css/main.css; address and contact are in content/site.md.
+export default defineAppConfig({
+  site: {
+    // shortName: 'Site',
+    // logo: { src: '/logo.svg', width: 120, height: 32 },
+    // One line under the name in the footer, per language.
+    tagline: {
+      en: 'Translations between German and English for museums, research and publishers.',
+      de: 'Übersetzungen zwischen Deutsch und Englisch für Museen, Forschung und Verlage.',
+    },
+    organization: 'Organization',
+    // Entries of content/pages/ by id (`pages/<file name without number>`), at most 6.
+    nav: [{ entry: 'pages/about' }, { entry: 'pages/contact' }],
+    footer: [],
+    // For example { label: 'Mastodon', url: 'https://mastodon.social/@my-site' }.
+    socials: [],
+  } satisfies SiteAppConfig,
+})

package/templates/starter/app/app.vue

@@ -0,0 +1,7 @@
+<!-- Synced from templates/_features/site/app/app.vue by `pnpm templates sync`. Edit the source, not this copy. -->
+<template>
+  <NuxtRouteAnnouncer />
+  <NuxtLayout>
+    <NuxtPage />
+  </NuxtLayout>
+</template>

package/templates/starter/app/assets/css/main.css

@@ -0,0 +1,19 @@
+@import "tailwindcss";
+@import "tw-animate-css";
+@import "./tokens.css";
+
+/* This template's accent and fonts (DESIGN.md "Your accent"). Everything else comes from tokens.css.
+   starter: neutral. Text on the accent 17.7:1 light, 16.1:1 dark; the accent on the page 17.7:1 / 17.9:1.
+   The focus ring and links in text use the accent. */
+:root {
+  --brand: #18181b;
+  --brand-foreground: #ffffff;
+  /* @nuxt/fonts serves Inter from the site and adds size-matched fallbacks. */
+  --font-body: "Inter", ui-sans-serif, system-ui, sans-serif;
+  /* An optional display face for headings: --font-heading: "Fraunces", serif; */
+}
+
+.dark {
+  --brand: #f4f4f5;
+  --brand-foreground: #18181b;
+}