From 0911a76f2e08973ead92bc3683de8ad44d174969 Mon Sep 17 00:00:00 2001 From: Alex Dunmow Date: Sun, 5 Jul 2026 13:43:43 +0800 Subject: [PATCH] docs: publishing README --- README.md | 62 ++++++++++++++----------------------------------------- 1 file changed, 15 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 3e6ae31..b9dc172 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,24 @@ # Gotham -The after-dark identity of a nightlife venue or private members' club. Cinematic -near-black luxe, brass hairline accents, letterboxed heroes and tall condensed -display type. A codeless BlockNinja `.bnp` theme (no Go, no `plugin.wasm`) — every -block, page template, override and the email wrapper is a host-rendered -`.ninjatpl`. +An after-dark theme in near-black with brass hairline accents. Tall condensed headlines sit over letterboxed hero bars, so pages carry the mood of a private members' club after midnight. It reads exclusive and filmic. The look is cinematic luxe, the kind of page that feels like an invitation. -## Identity +## Good for -- **Palettes** — five dual-mode presets. Light is silver-screen platinum; dark - is velvet black. Both are intentionally tuned (`presets.json`). -- **Type** — Antonio (condensed display headings), Cormorant Garamond (elegant - body), Inter (meta), IBM Plex Mono (mono). Bundled OFL woff2 in - `assets/fonts/`; always consumed via `var(--font-heading|body|mono, ...)`. -- **Motion** — MID tier. JS scroll reveals and a spotlight-follow on the hero. - No canvas. `prefers-reduced-motion` honoured; renders fully with no JS. -- **Utilities** — `reel-*`, `film-grain`, `spotlight`, `letterbox-scrim`, - `reveal` in `manifest.yaml` `css.input_css_append`. Colour is always - `hsl(var(--token))`. +We built Gotham for nightlife and hospitality. Treat these as starting points, not limits. If the mood fits your brand, use it: -## Page templates (`templates/gotham/`) +- Nightclubs and late-night lounges +- Private members' clubs +- Cocktail bars and speakeasies +- Event spaces and ticketed shows -`default`, `landing`, `article`, `full-width`, `blog-index`, `contact`, `auth`, -plus `centered` (retained extra key). +## What you get -## Overrides (`templates/overrides/gotham/`) +- Five color presets, each with a tuned light mode and a tuned dark mode: Velvet Black, Midnight Brass, Noir Rose, Smoke & Silver, and Bourbon. +- Four bundled fonts, ready to assign: Antonio for condensed display headings, Cormorant Garamond for elegant serif text, Inter for interface copy, and IBM Plex Mono. Fonts stay admin-controlled, so you can swap them from the typography settings. +- Four persona blocks: a door strip for guest-list and entry details, an events marquee, a membership-tiers section, and a bottle-service menu. +- A demo site that installs when you activate the theme: a home page, an about page, a short blog with three posts, and a contact page whose form emails your admins. +- Every core block restyled to match, plus a themed login screen and a themed 404 page. -All 49 mandatory builtin keys are re-skinned as template overrides (chrome, -marketing, primitives, commerce/local, blog family, auth surface, the themed -404). Fields, provider reads, form wiring and block JS are preserved verbatim -from the frozen builtins; only presentation changes. +## Install -## Theme blocks (`blocks/`) - -True persona furniture only: - -- `gotham:door_strip` — sticky door strip (reservations line, guest-list CTA, hours) -- `gotham:events_marquee` — line-up of nights and residencies -- `gotham:membership_tiers` — membership cards -- `gotham:bottle_menu` — cellar / bottle-service list - -## Seed (`seed/`) - -`seed.json` (`demo: true`) installs a private-club demo: home, about, a journal -with three posts, a door/contact page (form + `contact_submissions` data table), -and a members' login. `workflows.json` emails admins on a form submission. - -## Build - -``` -make # pack gotham-.bnp (codeless, no wasm) -make verify # loader-identical checks -make archive-check -make publish # ninja plugin publish --bnp -``` +Install from the BlockNinja registry, then pick a preset and assign your fonts in the admin. Activate the demo content if you want a fully dressed starting point.