create-ginko 0.4.0 → 0.5.0

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

@@ -0,0 +1,27 @@
+# Media
+
+Photos and other media in this template, with their source and license. The code is MIT (see LICENSE); media keep
+their own license. People are shown with their initials, never with stock photos of faces.
+
+## Photos
+
+The [Unsplash License](https://unsplash.com/license) allows free use, also commercial, without asking; it does not
+allow selling the photos as they are or building a similar photo service.
+
+| File | Used in | What | Source | License |
+|---|---|---|---|---|
+| `public/media/treatment-room.jpg` | home page (hero), page "About us", contact page ("The practice") | a treatment room with a padded bench, a trolley and a large window | [nightingaledxb on Unsplash](https://unsplash.com/photos/black-and-white-massage-bed-4e017fuMeXE) | Unsplash License |
+| `public/media/massage.jpg` | contact page ("The practice") | a therapist's hands massage a patient's upper back | [heftiba on Unsplash](https://unsplash.com/photos/person-massaging-the-back-of-a-woman-hBLf2nvp-Yc) | Unsplash License |
+
+## 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 is under the
+[SIL Open Font License](https://openfontlicense.org).
+
+When you add a photo, put it in `public/media/`, give it alt text in every language file that shows it, and add a
+row here. The sample photos show another practice. Replace them with photos of your own rooms, and of your team only
+with their permission: patients like to see where they are going.

package/templates/local-business/NOTES.md

@@ -0,0 +1,31 @@
+# Notes before release
+
+- Sample data that must change before going live: `content/site.md` (address "Ahornhofgasse 12" in Graz, the
+  commented register lines, the sample phone number), the email address (`.example` domain), the people in `content/people/` (fictional
+  names and qualifications), the prices in `content/services/`, the phone hours and directions in `content/visit.md`
+  (tram stop "Ahornhofplatz"), the notice, the job opening on the About page and the legal texts (privacy policy and
+  imprint are marked placeholders for Austria; the payment and cancellation terms are a sample that matches the FAQ).
+- `bookingUrl` in `content/visit.md` is left out (a commented line shows its form): the sample books by phone and
+  email. With it set, the booking buttons (home, contact, treatment pages) get a third one, "Book online".
+- No `vat` in `app/app.config.ts`: physiotherapy is exempt from VAT in Austria, so the price labels say "Price". A
+  business whose prices include VAT sets `vat: 'included'` (README, "Prices").
+- The closures in `content/hours.md` (a team training day, the Christmas break) and the summer hours in
+  `content/hourPlans/` have fixed dates: create-ginko moves only dates of bricks with a `visible` rule (the notices).
+  Once a closure has passed it simply no longer shows; the summer hours repeat every year.
+- With `holidays: closed`, a public holiday on a day the practice is closed anyway (1 November 2026, a Sunday) is left
+  out of the closures (basics' `upcomingClosures`, shared with the restaurant).
+- The treatments have no photos: only two photos fit the sample, and cards with and without photos side by side look
+  unfinished. The treatment room photo is in the home page's hero and on the About page; both are on the contact page
+  ("The practice").
+- The home hero shows the treatment room (16:9; beside the text from lg, below the buttons on phones), so the first
+  screen shows the place. At 390 px the status, the call button and the phone hours stay above the photo.
+- The booking buttons keep one order: call, email, book online (17 Oct 2026). They used to put the email first once
+  today was over, but the phone hours are shorter than the opening hours and are free text (`visit.phoneHours`), so
+  the site cannot know whether the phone is answered right now. The phone hours stand directly under the call button.
+- A treatment's `contact` names the therapist who gives it ("Treated by"); the services feature's own wording for it
+  ("Contact person", "Or call …") is replaced by `app/components/services/Actions.vue`.
+- German says "Sie" on every page and uses Austrian words where they differ ("Wahlpraxis", "Verordnung", "verrechnen").
+- Script weight (gate 6, gzip, 16 Oct 2026, after the booking buttons became one component used by the home, contact
+  and treatment pages; every page prefetches the home page's chunks through the logo link): home 153.5 kB, FAQ 155.2,
+  team 156.0, contact 157.1, About and legal pages 157.8, the treatments list 160.4, the treatment pages 161.7.
+  `scriptBudget` is 165 kB (the cap for feature templates is 170).

package/templates/local-business/README.md

@@ -0,0 +1,256 @@
+# Local business
+
+A complete website for a practice, studio or shop that people visit by appointment: whether you are open today and
+until when, your treatments or services with price and duration, how to book (call during your phone hours, email, or
+your online booking page), where you are and how to get in (address, "Open in maps", step-free access, parking, public
+transport), the people who look after your customers, questions and answers, photos, and legal texts. 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 "Hofer Physio", a
+fictional physiotherapy practice in Graz, Austria.
+
+| Light | Dark |
+|---|---|
+| ![The local business template's home page in light mode](.github/screenshots/home-light.png) | ![The local business template's home page in dark mode](.github/screenshots/home-dark.png) |
+
+## Quick start
+
+```bash
+npm create ginko@latest my-site -- --template local-business
+```
+
+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 (the notices) 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/local-business#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 sample
+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%2Flocal-business&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.hofer-physio.at`. 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.
+
+The site runs as a server, not as static files: "Open now", today's hours and the closures follow the clock and the
+calendar, and a notice leaves the site the day after its last day, with no new build. Static files
+(`npm run generate`) would keep showing the hours and notices of the day they were built.
+
+## 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, prices, 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 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`) and repeats only what it translates: times, dates, prices and images come from the main file. A page
+(a treatment, a legal text or a free page) shows in a language only when its translation has every required text. The
+number at the start of a file name sets the order. After each change, run `npm run check`.
+
+Write dates as `2026-10-24`, times as `'09:30'`, prices as a plain number in euros (`95` or `12.50`). Files point to
+other entries by id: the folder and the file name without number and language, so `content/people/1.anna-hofer.md` is
+`people/anna-hofer`. The `slug` is only the address on the site: renaming a file breaks the references to it, changing
+the `slug` does not. A translation lists the rows in the same order as the main file: when you add, remove or move a row
+in the main file (an exception, a photo, a spec), 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.
+
+| On the site | File |
+|---|---|
+| Home page: name, one line about you, photo (optional, 16:9; without one the text takes the full width) | `content/home.md` (and `home.de.md`, which translates the alt text) |
+| Opening hours: the week, closures, public holidays | `content/hours.md`: `week` (each day `closed: true`, or `from1` and `to1`, and `from2` and `to2` for a break), `exceptions` (`when` with `from` and `to`, `reason`, `closed: true`; or `closed: false` with other times for those days), `holidays` (`closed`, `sunday` or `normal`); `hours.de.md` translates the reasons, row by row |
+| Other hours for a time of year or from a date | `content/hourPlans/<n>.<name>.md`: `label`, `from`, `to` (optional; without it the plan runs on with no end), `yearly` (`true`: the same dates every year; `false`: once), `week` (all seven days, like `week` in `hours.md`) |
+| Phone hours, online booking, access, parking, public transport | `content/visit.md`: `phoneHours` (short, as people read it; parts separated by commas, `Mon–Fri 08:00–12:00, Mon–Thu also 14:00–17:00`), `bookingUrl` (optional: your booking page elsewhere), `access`, `parking`, `transit` |
+| Treatments or services | `content/services/<n>.<name>.md`: `title`, `summary`, `pricing` (`price` or `onRequest`, always one of the two), `price` (in euros, `65` or `12.50`, required with `pricing: price`), `duration` (minutes), `specs` (rows of `label` and `value`; `<name>.de.md` translates them row by row), `contact` (optional: the person of `content/people/` who gives the treatment, `people/anna-hofer`; the page says "Treated by Anna Hofer"), `image` (3:2; give every entry one, or none), the text |
+| The team | `content/people/<n>.<name>.md`: `name`, `role` (with the qualification), `bio`, `photo` (optional, 4:5; without one the site shows initials), `email` and `phone` (optional, only a person's own) |
+| Questions and answers | `content/faq/<n>.<name>.md`: `question`, `answer`; the home page shows the first three |
+| Photos of the practice (contact page) | `content/gallery.md`: `images`, each with `src` and `alt`; `gallery.de.md` translates the alt texts, row by row |
+| About us 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) 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, register entry, email, phone | `content/site.md` (the call and email buttons on the home, contact and treatment pages, footer, imprint, search engines) |
+| Privacy policy, payment and cancellation, imprint | `content/legal/` (privacy policy and imprint are placeholders for Austria; the payment and cancellation terms are a sample that matches the FAQ: replace all three before you go live) |
+| Site name, description for search engines, currency, country | `ginko.config.ts` (`name`, `seo.description`, `currency`, `country`) |
+| Menu, footer links, the line under the name in the footer | `app/app.config.ts` |
+| The home page's title in search results and tabs, section titles, the texts of the pages | `i18n/<language>.json` (`home.title` is "Physiotherapy in Graz"); the features' own texts are in `i18n/<feature>/<language>.json`, and a key set in `i18n/<language>.json` wins (this template renames "Services" to "Treatments" that way) |
+
+**Opening hours.** One rule shows everywhere: the line at the top of the home page ("Open now until 19:00", "Opens
+today at 07:30", "Closed today" with the reason), the week with today marked, the footer of every page and the
+opening hours search engines read. Public holidays come from `country` in `ginko.config.ts` (`AT`: the Austrian
+holidays); with `holidays: closed` they show as closures, like your own. The list of closures shows the next 90 days,
+and leaves out a public holiday on a day you are closed anyway. To close on a single day, add it to `exceptions` with
+the same `from` and `to`. Times use 24 hours (`'07:30'`).
+
+A plan from `content/hourPlans/` replaces the whole week for its dates, so it lists all seven days; to add Saturday
+hours, copy the week of `hours.md` and change Saturday. When two plans cover the same day, the one with the later `from`
+date wins. A yearly plan counts with the `from` in its file, not with this year's date. So new hours that start after
+that date win over the yearly plan every year after. To keep both, move the yearly plan's `from` to the same day and
+month in the year the new hours start, or give the new plan a `to`.
+
+**Prices.** Every treatment says how it is priced: `pricing: price` with a `price`, or `pricing: onRequest` (the home
+visits). The page shows the price in the visitor's language ("€65", "€ 65"), and search engines get the same price; an
+entry on request shows "On request" and gives search engines no price. A fixed price without an amount is a mistake:
+the build stops on it and names the entry, and the Studio does not save it. Physiotherapy is exempt from VAT in
+Austria, so the labels say "Price" with no VAT note. If your prices include VAT, set `vat: 'included'` in
+`app/app.config.ts`: the labels then say "incl. VAT", and so does the data for search engines.
+
+**Booking.** The home page, the contact page and every treatment page show the same buttons
+(`app/components/visit/Book.vue`): "Call" with your number, your phone hours right under it, "Send an email" (on a
+treatment page with the treatment in the subject) and "Book online" when `content/visit.md` has a `bookingUrl`.
+The order is fixed: call, then email, then online booking (each only when it exists), and the first one is the main
+button. A treatment page shows these buttons through
+`app/components/services/Actions.vue`, which the services feature shows in place of its own. The site has no booking
+form (see "Add a booking or contact form").
+
+**Notices** show newest first, so 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, at the top of every page, so keep them for news a visitor
+needs before they come (a closure, building work), not for news about you (a job opening belongs on the About page).
+When a notice changes access or parking, check `content/visit.md` too, so the directions say the same. The sample has
+one about the courtyard parking; delete it for your site.
+
+## 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` of `ginko.config.ts`, `title` of `content/home.md`, `legalName` of `content/site.md` (with
+  the legal form) and `summary` of `content/pages/1.about.md` and `1.about.de.md`. Search `content/` for it and replace
+  what is left.
+- **Menu.** `nav` in `app/app.config.ts` holds at most six items: a page of `ginko.config.ts`
+  (`{ page: 'faq', label: { … } }`, label per language, the same words as the page's title) or a page of
+  `content/pages/` by id (`{ entry: 'pages/about' }` is `content/pages/1.about.md`).
+- **Logo.** Put the file in `public/` and set `logo: { src: '/logo.svg', width: 140, height: 32 }` in
+  `app/app.config.ts`. Without it, the header shows the name.
+- **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). This template
+  uses teal (`#0f766e`, dark `#5eead4`). 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` in `main.css`. `@nuxt/fonts` downloads the fonts at build time and serves them from your
+  site.
+- **Kind of business.** The home page tells search engines that you are a `Physiotherapy` (a kind of LocalBusiness)
+  with your opening hours: change `'@type'` in `app/pages/index.vue` for another kind (`Dentist`,
+  `HealthAndBeautyBusiness`, `Store` …). Address and contact come from `content/site.md`, the country from `country`
+  in `ginko.config.ts`.
+- **Addresses.** The words of the addresses per language (`services` → `treatments`, `behandlungen`; `faq` →
+  `faq`, `fragen`) 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.first-visit.md` with a `title`, an optional `summary` and the text below the
+frontmatter. It appears at `/first-visit`; each translation sets its own address with `slug:` (`slug: erster-besuch`
+in `2.first-visit.de.md` gives `/de/erster-besuch`). Add `{ entry: 'pages/first-visit' }` 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/prices.vue`. Start it with
+`<BlockPageHeader>` and call `usePageSeo()`, like `app/pages/faq.vue`. Register it in `ginko.config.ts` under `pages`
+(`prices: localized('/prices')`) and add the words of its address per language to `segments` in `app/routes.ts`
+(`prices: { en: 'prices', de: 'preise' }`). It then answers at `/prices` and `/de/preise`, and
+`useGinkoPath()('prices')` 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 local-business --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 Italian): add `'it'` to `locales` and a word per address in `app/routes.ts`, its tag to
+  `languages` in `ginko.config.ts` (`it: 'it-IT'`), and the Italian labels of `nav`, `footer` and `tagline` in
+  `app/app.config.ts` (without them they show in the main language). Add `i18n/it.json` and the texts of every
+  `i18n/<feature>/en.json` translated as `i18n/<feature>/it.json`.
+- **Translate the content** as `content/**/*.it.md`. A page shows in the new language only once it has its
+  translation file: without one it is not on the Italian 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 a booking or contact form
+
+The site sends no data to other companies, so it has no forms: "Call" and "Send an email" use the visitor's phone and
+email program, and "Open in maps" opens OpenStreetMap only when they choose it. To take
+bookings online, set `bookingUrl` in `content/visit.md` to the page of your booking service: the home and contact pages
+then link to it. Name the service in your privacy policy.
+
+## Remove a feature
+
+Links in the content name pages by their key (`[how to find us]($page.contact)`). 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 |
+|---|---|
+| Treatments | `content/services/`, the `services` brick and `pages.services` in `ginko.config.ts`, `services` in `segments` of `app/routes.ts`, its `nav` item, in `app/pages/index.vue` the "Treatments and prices" section and its script lines (`useGinko('services')` and `useServiceCards`), `app/pages/services/`, `app/components/services/`, `app/bricks/services.ts`, `app/composables/useServices.ts`, `i18n/services/`, the `services` keys in `i18n/<language>.json`, the link to `$page.services` in `content/legal/2.terms*.md`, and `"services"` in `package.json` → `ginko.features` |
+| Team page | `pages.team`, `team` in `segments` of `app/routes.ts`, its `nav` item, in `app/pages/index.vue` the "Our team" section and its `useGinko('people')` line, `app/pages/team.vue`, `app/components/people/`, `i18n/people/`, `"people"` in `ginko.features`, the link to `$page.team` in `content/pages/1.about*.md`, the "Treated by" link in `app/components/services/Actions.vue` (keep the name without the link); keep the `people` brick in `ginko.config.ts` (a treatment's optional `contact` names a person); `content/people/` may be empty |
+| Questions and answers | `content/faq/`, the `faq` brick and `pages.faq`, `faq` in `segments` of `app/routes.ts`, its `nav` item, in `app/pages/index.vue` the "Questions" section and its script lines (`useGinko('faq')` and `faqItems`), `app/pages/faq.vue`, `app/components/block/Faq.vue`, `app/components/ui/accordion/`, the `faq` keys in `i18n/<language>.json`, `"faq"` in `ginko.features` |
+| Photos | `content/gallery.md` and `content/gallery.*.md`; in `ginko.config.ts` the `gallery` brick and `gallery` in the `@lupinum/ginko/basics` import; in `app/pages/contact.vue` "The practice" section and its script lines (`useGinko('gallery')` and `images`); `app/components/block/Gallery.vue`, `app/components/site/Lightbox.vue`, `i18n/gallery/`, the `contact.practice` key in `i18n/<language>.json`, `"gallery"` in `package.json` → `ginko.features` |
+| Opening hours | not on its own: the home page, the contact page and the footer are built around them. Without fixed hours ("by appointment only"), keep the feature and mark every day `closed: true`, then remove `<HoursToday />` and the hours sections from `app/pages/index.vue` and `app/pages/contact.vue`, the `openingHoursJsonLd` part of the home page's `usePageSeo`, and `app/components/site/FooterStatus.vue` (else every footer says "Closed today") |
+| Hours from a date | `content/hourPlans/`, the `hourPlans` brick, its import and `plans: 'hourPlans'` of the `hours` brick in `ginko.config.ts`, in `app/composables/useHours.ts` the `useGinko('hourPlans')` line (then `plans` is an empty list: `computed<HourPlan[]>(() => [])`) |
+| 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 |
+
+## 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 legal name, address, register entry 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.
+- [ ] `content/hours.md` has your week, your closures for the coming months and your rule for public holidays;
+      `content/hourPlans/` only holds hours you really use.
+- [ ] Every treatment has your price or `pricing: onRequest`, and the price labels fit your VAT (`vat` in
+      `app/app.config.ts`).
+- [ ] `content/visit.md` has your phone hours and your directions; the FAQ states your real cancellation rule.
+- [ ] The sample people, notices and photos are replaced or deleted; people only with their permission.
+- [ ] The placeholders in `content/legal/` are replaced by your own texts, and the ones you do not need are deleted.
+- [ ] Every photo you added has alt text in each language file that shows it and a source in `MEDIA.md`.
+
+## Move to the Studio
+
+Ginko Studio is Lupinum's hosted editor: from a phone, you close today ("Closed today" with a reason), add your
+holidays, post a notice until a date or change a price, and the Today page starts with today's hours, the notices,
+the treatments and the team. 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/local-business/app/app.config.ts

@@ -0,0 +1,32 @@
+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: 140, height: 32 },
+    // One line under the name in the footer, per language.
+    tagline: {
+      en: 'Physiotherapy in Graz, by appointment.',
+      de: 'Physiotherapie in Graz, nach Terminvereinbarung.',
+    },
+    // The schema.org type of the home page's organisation. This home page makes it `Physiotherapy` (a kind of
+    // LocalBusiness) with the opening hours (app/pages/index.vue); remove that, and this applies.
+    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: 'services', label: { en: 'Treatments', de: 'Behandlungen' } },
+      { page: 'team', label: { en: 'Team', de: 'Team' } },
+      { entry: 'pages/about' },
+      { page: 'faq', label: { en: 'FAQ', de: 'Häufige Fragen' } },
+      { page: 'contact', label: { en: 'Contact', de: 'Kontakt' } },
+    ],
+    footer: [],
+    // For example { label: 'Instagram', url: 'https://www.instagram.com/…' }.
+    socials: [],
+    // No `vat`: physiotherapy is a medical treatment and exempt from VAT in Austria, so the labels say "Price" with no
+    // VAT note. Set `vat: 'included'` when your prices include VAT ("Price (incl. VAT)", also for search engines), or
+    // `vat: 'excluded'` for net prices to businesses.
+  } satisfies SiteAppConfig,
+})

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

@@ -0,0 +1,18 @@
+@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.
+   local-business: teal. White on the accent 5.5:1 light; the accent on the page 5.5:1 light (5.0:1 on --muted);
+   #042f2e on the dark accent 9.8:1; the dark accent on the page 13.3:1. The focus ring and links in text use the accent. */
+:root {
+  --brand: #0f766e;
+  --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;
+}
+
+.dark {
+  --brand: #5eead4;
+  --brand-foreground: #042f2e;
+}