create-ginko 0.4.0 → 0.6.0

package/templates/portfolio/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/portfolio/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/portfolio/MEDIA.md

@@ -0,0 +1,35 @@
+# Media
+
+Photos in this template, with their source and license. The code is MIT (see LICENSE); media keep their own license.
+All photos are under the [Unsplash License](https://unsplash.com/license): free to use, also commercially, without
+asking; it does not allow selling the photos as they are or building a similar photo service. They are credited here
+anyway. People are shown with their initials, never with stock photos of faces.
+
+The photos show other rooms and objects than the sample text describes. Replace them with photos of your own work
+before you go live: clients choose a studio by its work.
+
+| File | Size | Used in | Photo | By | License |
+|---|---|---|---|---|---|
+| `public/media/attic-light.jpg` | 1600 × 1067 (3:2), re-encoded to 160 kB | project "Attic flat in Ottensen" (main photo) | [sunlight streams through a window onto a wall](https://unsplash.com/photos/sunlight-streams-through-a-window-onto-a-wall-IiyAiqcw2VQ) | [lugoviews](https://unsplash.com/@lugoviews) | Unsplash License |
+| `public/media/ceramic-vases.jpg` | 1600 × 1067 (3:2) | project "Elbsand vases" (main photo) | [ceramic vases on wooden surface](https://unsplash.com/photos/ceramic-vases-on-wooden-surface-R0qthXq3jec) | [crystalmind_design](https://unsplash.com/@crystalmind_design) | Unsplash License |
+| `public/media/concrete-stair.jpg` | 1600 × 1050 | project "Entrance hall for Werftblick" (main photo) | [white concrete wall during daytime](https://unsplash.com/photos/white-concrete-wall-during-daytime-NRLnzGXtoE4) | [dorsamasghati](https://unsplash.com/@dorsamasghati) | Unsplash License |
+| `public/media/oak-chair.jpg` | 1600 × 900 (16:9) | project "Holm chair" (main photo) | [a wooden chair on a white background](https://unsplash.com/photos/a-wooden-chair-on-a-white-background-iBxQvOLuKb4) | [hongly_9](https://unsplash.com/@hongly_9) | Unsplash License |
+| `public/media/workshop-drawings.jpg` | 1600 × 1200 (4:3) | projects "Attic flat in Ottensen" and "Holm chair" (`photos`) | [a wooden table topped with a piece of paper and a pair of scissors](https://unsplash.com/photos/a-wooden-table-topped-with-a-piece-of-paper-and-a-pair-of-scissors-OspMUpCBeqQ) | [declansun](https://unsplash.com/@declansun) | Unsplash License |
+| `public/media/material-samples.jpg` | 1600 × 1067 (3:2) | projects "Elbsand vases" and "Entrance hall for Werftblick" (`photos`) | [various textures and patterns are displayed up close](https://unsplash.com/photos/various-textures-and-patterns-are-displayed-up-close-ST-QAmN8BIk) | [declansun](https://unsplash.com/@declansun) | Unsplash License |
+
+The template has six photos for four projects: each project has its own main photo, and the two workshop photos
+(drawings on a table, material samples) are reused as the second photo of two projects each, with a description that
+fits that project. Your own projects will each have their own photos.
+
+## Made for this template
+
+| File | What | License |
+|---|---|---|
+| `.github/screenshots/home-light.png`, `home-dark.png` | screenshots of this template | MIT, like the code |
+
+The share cards (1200 × 630) are generated by the site (nuxt-og-image). Inter and Instrument Serif are under the
+[SIL Open Font License](https://openfontlicense.org).
+
+When you add a photo, put it in `public/media/`, give it a description (`alt`) in every language file that shows it,
+and add a row here. Keep each file at about 200 kB or less (1600 px on the long side is enough): phones with a sharp
+screen may load the original file, so its size counts for how fast the first screen shows.

package/templates/portfolio/NOTES.md

@@ -0,0 +1,18 @@
+# Notes before release
+
+- Sample data that must change before going live: `content/site.md` (a made-up street, a phone number that reaches nobody and
+  a VAT number that fails its check), the email addresses (they end in `.example`), the people in `content/people/` (fictional), the client
+  "Werftblick Wohnbau eG" (fictional), the projects, the journal entries, the notice about the Holm chair, the photos (stock
+  photos of other rooms and objects, see `MEDIA.md`) and the legal texts (marked placeholders).
+- The photos are stock photos that match the sample projects only loosely (the "oak" chair is a light wood chair from
+  a stock series).
+- Two photos are each used in two projects (`MEDIA.md`), because six photos had to serve four projects with a second
+  photo each.
+- Nobody has filled the "Responsible for the journal" part of the imprint; it is a marked placeholder like the
+  privacy policy.
+- German says "Sie" on every page: the studio speaks to clients.
+- The home page shows the first three projects in the studio's order; there is no "featured" field. The work page has
+  no filter by type: with server rendering a `?type=` filter would work without JavaScript, but `nuxt generate`
+  (offered for this template) prerenders one page per address and ignores the query, so the filter would break there.
+  With four to twenty projects a studio does not need one.
+- Journal entries have no tags: the tag pages are `?tag=` filters too (blog feature), which a static build ignores.

package/templates/portfolio/README.md

@@ -0,0 +1,267 @@
+# Portfolio
+
+A complete website for a design studio, an architect, a maker or a photographer: the work as large photos on the home
+page, a page per project with its facts (client, year, place, scope), all its photos with their descriptions and a
+lightbox, the people of the studio, a page on how a project runs, a journal with an RSS feed, and legal texts. One
+main action on every page: "Start a project", an email with the subject filled in, next to the phone and the
+address. 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. The sample is "Studio Maren Holt", a fictional interior and object design studio in Hamburg.
+
+| Light | Dark |
+|---|---|
+| ![The portfolio template's home page in light mode](.github/screenshots/home-light.png) | ![The portfolio template's home page in dark mode](.github/screenshots/home-dark.png) |
+
+## Quick start
+
+```bash
+npm create ginko@latest my-site -- --template portfolio
+```
+
+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 notice's end date by the weeks since the sample was made, 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/portfolio#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. With this route the sample dates stay as they are: a notice
+whose last day has passed is simply not shown.
+
+## 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%2Fportfolio&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.studio-maren-holt.de`. 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.
+
+### Static files
+
+A portfolio changes when you add a project or a journal entry, so it can also be built as static files and served by
+any web host, without Node:
+
+```bash
+npm run generate
+```
+
+The files are in `.output/public/`; upload that folder. Every page, the sitemap, `llms.txt` and the journal feeds are
+written at build time. What that means:
+
+- **Everything changes with a build.** A new project, photo or journal entry goes online when you build and upload
+  again (on Vercel or Netlify: with the next push).
+- **Notices** (`content/notices/`) leave the site only with the next build after their `until` day. If you use them,
+  add a daily rebuild (for example a Vercel cron job that calls a deploy hook, or a scheduled GitHub Action).
+- **Scheduled journal entries.** An entry whose `date` is after the build day stays off the site; it goes online with
+  the first build on or after that day (in files mode and in the Studio). A file with `draft: true` never does. If you
+  schedule entries, add a daily rebuild too.
+- **Share cards** are generated by the server (`nuxt-og-image`). With static files, each page's card is rendered once
+  at build time.
+
+Run as a server (`npm run build`), notices end on their day by themselves; scheduled journal entries still need a
+build on their day.
+
+## Develop, build, preview
+
+| Command | What |
+|---|---|
+| `npm run dev` | the site with live reload on http://localhost:3000; drafts show here |
+| `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/`; drafts are left out |
+| `npm run generate` | static files in `.output/public/` instead of a server (see "Static files") |
+| `npm run preview` | runs that build locally |
+| `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 (`holm-chair.md`); a translation adds the language
+code (`holm-chair.de.md`) and repeats only what it translates: the year, files and images come from the main file,
+and each photo's description is written per language. A page (a project, journal entry, legal text or free page)
+shows in a language only when its translation has every required text (for a project: `title`, `slug`, `summary` and
+the text). The number at the start of a file name sets the order. Write dates as `2026-10-24`. 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/people/1.maren-holt.md` is `people/maren-holt`. The `slug` is only the address on the site: renaming a file
+breaks the references to it, changing the `slug` does not.
+
+| On the site | File |
+|---|---|
+| Home page: what the studio does in one sentence, and a lead | `content/home.md` (and `home.de.md`) |
+| Projects | `content/projects/<n>.<name>.md`: `title`, `slug` (the address; without it, the file name), `summary` (below the title and in search results), `client` (a name, or "Private client"; leave it out for your own pieces), `year`, `place`, `scope` (what you did, in a few words), `image` (the main photo, 3:2 on the cards: put the file in `public/media/` and write `src: /media/name.jpg`), `photos` (more photos, each `image` with `src` and `alt`), the text; `draft: true` keeps a project off the site while you work on it |
+| Journal | `content/posts/<name>.md`: `title`, `description` (the summary), `date` (`YYYY-MM-DD`; a later day keeps it off the built site until then), `authors` (people by id, `[people/maren-holt]`), `image` (optional, 3:2), the text; `draft: true` keeps an entry off the site |
+| People of the studio | `content/people/<n>.<name>.md`: `name`, `role`, `bio`, `email`, `phone`; no photo needed, the site shows initials |
+| How we work, and other pages | `content/pages/<n>.<name>.md`; each translation 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), `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, VAT number, email, phone | `content/site.md` (footer, imprint, "Start a project", search engines) |
+| Privacy policy, imprint | `content/legal/` (placeholders for Germany: 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 | `app/app.config.ts` |
+| The home page's title in tabs and search results, section titles, the subject of the "Start a project" email, the leads of the work, studio and journal pages | `i18n/<language>.json` (`home.title`, `start.subject`, `projects.lead`, `people.lead`, `blog.lead`); the features' own texts are in `i18n/<feature>/<language>.json`, and a key set in `i18n/<language>.json` wins (this template renames "Projects" to "Work", "Team" to "Studio" and "News" to "Journal" that way) |
+
+**Projects.** The home page shows the first three projects (the smallest numbers), the first one wide; the work page
+shows all of them. To change the selection, change the numbers. Only the main file's number counts; rename the
+translation too if you want the files to stay side by side. A project's page shows the main photo and every photo of
+`photos`, large and one below the other, each with its description below it; a click opens the lightbox, which shows
+the whole photo. Then its facts, the text and the next project (after the last, the first).
+
+**Photo descriptions.** Every photo needs `alt`: what the photo shows, in a short sentence. It is shown below the
+photo, read out by screen readers and given to search engines. The build stops on a photo without one in the main
+language and names the file; a translation without its own description shows the main language's. Write one per
+language. In a translation, `photos` has one row per photo of the main file, in the same order, with only its `alt`:
+rows are matched by position, not by `src`. When you add, remove or move a photo in the main file, do the same at the
+same place in each translation (write `- {}` for a row with nothing to translate). `npm run check` reports a
+translation with a different number of rows.
+
+**Start a project.** The button opens an email to the address of `content/site.md` with the subject of
+`start.subject` ("Project enquiry"). It is on the home page, on every project page, on the studio page and on the "How we work" page, next
+to the phone number and the address. If you rename `content/pages/1.how-we-work.md`, change the id in
+`app/components/pages/Top.vue` too; it shows the block on that page only. To change where it leads, change the email in `content/site.md`.
+
+Each language has a journal feed at `<journal page>/rss.xml` (`/journal/rss.xml`, `/de/journal/rss.xml`).
+
+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
+
+- **Name.** `name` in `ginko.config.ts` (header, footer, share cards, search engines). The sample name also appears as
+  text in `seo.description` in `ginko.config.ts` and the person Maren Holt in `content/site.md` (`legalName`) and
+  `content/people/1.maren-holt.md` with its translation. Search `content/` and `i18n/` for it and replace what is
+  left. `legalName` (a person or a company) is shown in the imprint, the address and after © in the footer; without it
+  the footer shows `name`. For a long name, add `shortName` in `app/app.config.ts` (`site: { shortName: '…' }`):
+  phones show it instead.
+- **Menu.** `nav` in `app/app.config.ts` holds at most six items: a page of `ginko.config.ts`
+  (`{ page: 'news', label: { … } }`, label per language, the same words as the page's title) or a page of
+  `content/pages/` by id (`{ entry: 'pages/how-we-work' }` is `content/pages/1.how-we-work.md`).
+- **Logo.** Put the file in `public/` and set `logo: { src: '/logo.svg', width: 160, height: 32 }` in
+  `app/app.config.ts`. Without it, the header shows the name in the heading font.
+- **Colour.** `--brand` and `--brand-foreground` in `app/assets/css/main.css`, once for light and once for dark
+  (`.dark`), `--brand-surface` and `--brand-surface-foreground` (the closing band, in `.dark` only), and the light
+  value as `seo.color` in `ginko.config.ts` (the background of the share cards). This template uses stone, almost
+  black (`#1c1917`) and almost white in dark mode (`#f5f5f4`), so the photos carry the colour; the closing band uses
+  the zinc of the neutrals (`#27272a`) in dark mode. 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.
+- **Fonts.** `--font-body` (Inter) and `--font-heading` (Instrument Serif, headings from the size of a section title
+  up) in `main.css`. `@nuxt/fonts` downloads the fonts at build time and serves them from your site; a font with only
+  some weights is listed in `fonts.families` in `nuxt.config.ts` (Instrument Serif has one, 400). To use one face for
+  everything, delete `--font-heading` and the `@layer base` block of `main.css`.
+- **Organisation type.** `organization: 'LocalBusiness'` in `app/app.config.ts`, and the home page tells search
+  engines the studio is a `ProfessionalService` (`app/pages/index.vue`); address and contact come from
+  `content/site.md`, the country from `country` in `ginko.config.ts`.
+- **Addresses.** The words of the addresses per language (`projects` → `work`, `projekte`; `team` → `studio`;
+  `news` → `journal`) are in `app/routes.ts`. Change a word there; the pages, the menu and the links follow.
+
+`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/2.press.md` with a `title`, an optional `summary` and the text below the
+frontmatter. It appears at `/press`; each translation sets its own address with `slug:` (`slug: presse` in
+`2.press.de.md` gives `/de/presse`). Add `{ entry: 'pages/press' }` to `nav` or `footer` in `app/app.config.ts` to
+link it.
+
+**A page with its own layout:** add a Vue file in `app/pages/`, for example `app/pages/exhibitions.vue`. Start it with
+`<BlockPageHeader>` and call `usePageSeo()`, like `app/pages/team.vue`. Register it in `ginko.config.ts` under `pages`
+(`exhibitions: localized('/exhibitions')`) and add the words of its address per language to `segments` in
+`app/routes.ts` (`exhibitions: { en: 'exhibitions', de: 'ausstellungen' }`). It then answers at `/exhibitions` and
+`/de/ausstellungen`, and `useGinkoPath()('exhibitions')` links to it.
+
+## 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:** start fresh with `npm create ginko@latest my-site -- --template portfolio --locales en`, or delete
+  it from `locales` and from the maps in `app/routes.ts` and `languages` in `ginko.config.ts`, then delete its files
+  (`*.de.md`, `i18n/de.json`, `i18n/*/de.json`).
+- **Add one** (for example French): add `'fr'` to `locales` and a word per address in `app/routes.ts`, its tag to
+  `languages` in `ginko.config.ts` (`fr: 'fr-FR'`), and the French labels of `nav` and `tagline` in
+  `app/app.config.ts` (without them they show in the main language). Add `i18n/fr.json` and the texts of every
+  `i18n/<feature>/en.json` translated as `i18n/<feature>/fr.json`.
+- **Translate the content** as `content/**/*.fr.md`, with a description (`alt`) for every photo. A page shows in the
+  new language only once it has its translation file: without one it is not on the French site, the menu leaves it
+  out, and links to it lead to its page in the main language. Translate at least the legal texts (`content/legal/`)
+  before the language goes live.
+
+## Add an enquiry form
+
+The site sends no data to other companies, so it has no forms: "Start a project" opens an email with the subject
+filled in. To use a form instead, link to a form service of your choice from a page of `content/pages/` (`actionLabel`
+and `actionUrl` give the page a button) and name the service in your privacy policy.
+
+## Remove a feature
+
+Links in the content name pages by their key (`[projects]($page.projects)`). After you remove a page, search
+`content/` for `$page.<key>` and remove or change those links: the build stops on a link that leads nowhere.
+
+| Feature | Delete |
+|---|---|
+| Journal | `content/posts/`, the `posts` brick, `pages.news` and `posts` in the import of `ginko.config.ts`, its `nav` item, the "From the journal" section of `app/pages/index.vue` (`useBlogPosts()`, `latest`, the section), the "Responsible for the journal" section of `content/legal/2.imprint*.md`, `app/pages/news/`, `app/components/blog/`, `app/composables/useBlog.ts`, `server/middleware/news-feed.ts`, `i18n/blog/`, the `blog` keys in `i18n/<language>.json`, `"blog"` in `package.json` → `ginko.features` |
+| Studio page (people) | `content/people/`, `pages.team` and its `nav` item, `app/pages/team.vue`, `app/components/people/`, `i18n/people/`, the `people` keys in `i18n/<language>.json`, `"people"` in `ginko.features`, `authors` in `content/posts/*.md` (they name the deleted people); the `people` brick and `people` in the import of `ginko.config.ts` only after the journal, whose `posts` brick uses it |
+| Free pages ("How we work") | `content/pages/`, the `pages` brick, its `nav` item, `app/pages/[...slug].vue`, `app/bricks/pages.ts`, `app/components/pages/Top.vue`, `"pages"` in `ginko.features`; the "Start a project" button stays on the home and project pages |
+| Notices | `content/notices/`, the `notices` brick, `<SiteNotice />` in `app/layouts/default.vue`, `app/components/site/Notice.vue` |
+| A language | 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 |
+
+The projects are the centre of this template; to remove them, start from the starter template instead. The photo
+viewer (`"gallery"` in `ginko.features`) is what the project pages show their photos with.
+
+## 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.
+- [ ] `content/site.md` shows your real name, address, VAT number and 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.
+- [ ] The sample projects, people and journal entries are replaced by your own, and the sample photos
+      (`public/media/`, see `MEDIA.md`) by photos of your work.
+- [ ] Every photo has a description (`alt`) in each language file that shows it, and a source in `MEDIA.md`.
+- [ ] The placeholders in `content/legal/` are replaced by your own texts.
+- [ ] If you build static files: a daily rebuild runs while you use notices (see "Static files").
+
+## Move to the Studio
+
+Ginko Studio is Lupinum's hosted editor: you add a project as a draft from the browser, add photos to it from your
+phone (the Studio does not save a photo without its description), write a journal entry and publish it now or later,
+and the Today page shows your drafts and how old the newest journal entry is. 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/portfolio/app/app.config.ts

@@ -0,0 +1,27 @@
+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: {
+    // logo: { src: '/logo.svg', width: 160, height: 32 },
+    // One line under the name in the footer, per language.
+    tagline: {
+      en: 'Interiors, furniture and objects, designed in Hamburg.',
+      de: 'Räume, Möbel und Objekte, entworfen in Hamburg.',
+    },
+    // The home page tells search engines that the studio is a ProfessionalService (a LocalBusiness with an address).
+    organization: 'LocalBusiness',
+    // At most 6. A page of ginko.config.ts (`page`, with its label per language; keep it the same as the page's
+    // title) or an entry of content/pages/ by id (`pages/<file name without number>`).
+    nav: [
+      { page: 'projects', label: { en: 'Work', de: 'Projekte' } },
+      { page: 'team', label: { en: 'Studio', de: 'Studio' } },
+      { entry: 'pages/how-we-work' },
+      { page: 'news', label: { en: 'Journal', de: 'Journal' } },
+    ],
+    footer: [],
+    // For example { label: 'Instagram', url: 'https://www.instagram.com/studio-maren-holt' }.
+    socials: [],
+  } satisfies SiteAppConfig,
+})

package/templates/portfolio/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/portfolio/app/assets/css/main.css

@@ -0,0 +1,56 @@
+@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.
+   portfolio: stone. White on the accent 17.5:1 light; the accent on the page 17.5:1 light; #1c1917 on the dark accent
+   16.5:1; the dark accent on the page 17.6:1. The photos carry the colour; the accent stays almost black and white.
+   The focus ring and links in text use the accent. */
+:root {
+  --brand: #1c1917;
+  --brand-foreground: #ffffff;
+  /* @nuxt/fonts serves Inter and Instrument Serif from the site and adds size-matched fallbacks. */
+  --font-body: "Inter", ui-sans-serif, system-ui, sans-serif;
+  /* Headings: a narrow display serif with one weight (400). */
+  --font-heading: "Instrument Serif", ui-serif, Georgia, serif;
+}
+
+/* Instrument Serif is narrow and has a small x-height: at the shared `text-h3` (19–23 px) a project title or a name
+   reads smaller than the 17 px Inter text below it. This template sets the step larger: 22 px on phones, 28 px from
+   1440 px (DESIGN.md, "Your accent", Headings). */
+@theme {
+  --text-h3: clamp(1.375rem, 1.2rem + 0.75vw, 1.75rem);
+  --text-h3--line-height: 1.2;
+}
+
+.dark {
+  --brand: #f5f5f4;
+  --brand-foreground: #1c1917;
+  /* The closing band in dark mode: the zinc of the neutrals (as --accent) instead of the near-white accent, so it
+     does not outshine the photos and matches the footer below it. #fafaf9 on #27272a 14.3:1. */
+  --brand-surface: #27272a;
+  --brand-surface-foreground: #fafaf9;
+}
+
+@layer base {
+  /* Instrument Serif has one weight. Headings use it as drawn, and the browser never fakes a bold of it (a heading
+     marked semibold in a shared component stays regular). Inter keeps its real weights. */
+  h1,
+  h2,
+  h3,
+  h4 {
+    font-weight: 400;
+  }
+
+  html {
+    font-synthesis-weight: none;
+  }
+
+  /* The display serif is for headings from text-h3 up. Small headings (the footer's column titles, labels, a
+     Markdown ###) stay in Inter, semibold: at body size the serif's thin strokes read as body text. */
+  :is(h1, h2, h3, h4):is(.text-xs, .text-small, .text-body),
+  .prose > h3 {
+    font-family: var(--font-body);
+    font-weight: 600;
+  }
+}