remarque-tokens 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENT_RULES.md +4 -2
- package/CHANGELOG.md +46 -0
- package/README.md +10 -2
- package/REMARQUE.md +86 -2
- package/package.json +3 -1
- package/tokens.json +1 -1
package/AGENT_RULES.md
CHANGED
|
@@ -26,7 +26,7 @@ Execute in this exact order. Do not skip steps. Do not reorder.
|
|
|
26
26
|
|
|
27
27
|
8. **Validate readability on mobile** before adding any visual polish.
|
|
28
28
|
|
|
29
|
-
9. **Verify every page conforms** to one of the
|
|
29
|
+
9. **Verify every page conforms** to one of the seven archetypes (Essay, Project Dossier, Notebook, Landing, Reference/Docs, Changelog, Gallery).
|
|
30
30
|
|
|
31
31
|
**Why this order matters:** Most agents build polished components first and bolt on typography later. That produces the exact aesthetic Remarque exists to prevent. Typography and prose are the foundation. Everything else is furniture.
|
|
32
32
|
|
|
@@ -160,6 +160,8 @@ project/
|
|
|
160
160
|
└── notes # Notebook archetype
|
|
161
161
|
```
|
|
162
162
|
|
|
163
|
+
Three further archetypes — Reference/Docs, Changelog, Gallery — are specified in REMARQUE.md but have no reference page in this repo's demo site yet; build them per spec, they follow the same file-structure conventions as the four above (e.g. `docs/[slug]`, `changelog`, `gallery` or `browse`).
|
|
164
|
+
|
|
163
165
|
### Implementation Pitfalls (learned from reference implementation)
|
|
164
166
|
|
|
165
167
|
1. **Tailwind spacing collision:** Never map Remarque's `--space-N` values onto Tailwind's default numeric spacing keys — in v4 `@theme` that means no `--spacing-9`…`--spacing-12`, and in the v3 config no `spacing: { "5"…"12" }` overrides — or `mt-12` produces 192px instead of 48px. Both shipped artifacts namespace instead: the v3 config exposes `mt-remarque-9` etc., the reference v4 `@theme` uses `--spacing-remarque-N`. Use those, or `var(--space-N)` in arbitrary values.
|
|
@@ -195,7 +197,7 @@ Before considering any implementation complete, verify:
|
|
|
195
197
|
- [ ] Accent color appears in ≤2 roles per viewport
|
|
196
198
|
- [ ] No scroll-triggered or entrance animations exist
|
|
197
199
|
- [ ] Every image has a 1px border and mono caption
|
|
198
|
-
- [ ] Every page maps to an archetype (Essay, Dossier, Notebook, Landing)
|
|
200
|
+
- [ ] Every page maps to an archetype (Essay, Dossier, Notebook, Landing, Reference/Docs, Changelog, Gallery)
|
|
199
201
|
- [ ] Mobile version is roomy — not a compressed desktop layout
|
|
200
202
|
- [ ] Mobile nav links have ≥44px touch targets
|
|
201
203
|
- [ ] No pure white or pure black backgrounds
|
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,52 @@ All notable changes to `remarque-tokens` are documented here. Token value
|
|
|
4
4
|
changes always state the design rationale — downstream sites pin against
|
|
5
5
|
these entries when syncing.
|
|
6
6
|
|
|
7
|
+
## 0.8.0 — 2026-07-21
|
|
8
|
+
|
|
9
|
+
Archetype-vocabulary and AI-agent-packaging release (design review; closes
|
|
10
|
+
#55, closes #57).
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
- **Three new page archetypes** (#55): Reference/Docs (persistent nav
|
|
14
|
+
rail, breadcrumb kicker, prev/next footer — reuses Essay's three-column
|
|
15
|
+
shape), Changelog (mono version/date headline, grouped Added/Changed/
|
|
16
|
+
Fixed lists — built from Notebook's entry structure), and Gallery
|
|
17
|
+
(content-wide cover grids, covers exempt from the reading-width cap,
|
|
18
|
+
border-only hover — formalized from tsundoku's documented reference
|
|
19
|
+
implementation, cited directly in REMARQUE.md). Seven archetypes total;
|
|
20
|
+
agents must not invent an eighth.
|
|
21
|
+
- **Plate** (#55): a screenshot-heavy-page subsection of Image Treatment —
|
|
22
|
+
numbered mono captions, a narrow 2-up exception for terminal captures.
|
|
23
|
+
- **CLI-tool landing guidance** (#55): a scoped, rationale-argued exception
|
|
24
|
+
to Landing's no-CTA rule for a single mono install command block.
|
|
25
|
+
- **Dataviz Tokens** (#55): chart grid/axis/categorical-ramp mapped onto
|
|
26
|
+
existing tokens and required to pass the audit — citing tsundoku's
|
|
27
|
+
orthogonal category-color system as precedent and naming the one gap
|
|
28
|
+
(never run through `remarque-audit`'s `CHECKS` array) this guidance
|
|
29
|
+
closes.
|
|
30
|
+
- **`remarque-tokens/agent-rules` and `remarque-tokens/spec` exports**
|
|
31
|
+
(#57): both files were already in `files`; this ships them as named
|
|
32
|
+
subpaths so a consumer can `require.resolve('remarque-tokens/agent-rules')`
|
|
33
|
+
instead of hardcoding a `node_modules` path.
|
|
34
|
+
- **`.claude/skills/remarque/SKILL.md`** (#57): a Claude Code skill
|
|
35
|
+
triggering on "remarque" / "design system" / new-page work. Loads
|
|
36
|
+
`AGENT_RULES.md` + `REMARQUE.md` + `tokens.json`, states the token-tier
|
|
37
|
+
rules, the audit command, and Pitfalls #6/#7 (string-form `@import`;
|
|
38
|
+
unlayered token import under Tailwind v4) inline — both pass a green
|
|
39
|
+
build while silently breaking, so they're worth surfacing without a
|
|
40
|
+
file round-trip.
|
|
41
|
+
- **`/tokens.json` on the demo site** (#57): `site/scripts/copy-tokens-json.mjs`
|
|
42
|
+
runs as a prebuild step (`npm run build` in `site/`), copying the
|
|
43
|
+
installed package's `tokens.json` into `public/` so it ships at
|
|
44
|
+
`https://williamzujkowski.github.io/remarque/tokens.json` — a remote
|
|
45
|
+
agent can fetch current token values instead of trusting training data.
|
|
46
|
+
The copy is generated, not a source file (`site/public/tokens.json` is
|
|
47
|
+
gitignored).
|
|
48
|
+
- Root README's "For AI Agents" section documents all three packaging
|
|
49
|
+
additions above.
|
|
50
|
+
|
|
51
|
+
No core-tier token values changed in this release.
|
|
52
|
+
|
|
7
53
|
## 0.7.0 — 2026-07-21
|
|
8
54
|
|
|
9
55
|
Typographic-completeness release (design review, #50/#51/#54): the
|
package/README.md
CHANGED
|
@@ -58,6 +58,11 @@ See: REMARQUE.md for specification, AGENT_RULES.md for implementation contract,
|
|
|
58
58
|
|
|
59
59
|
The agent rules define build order, non-negotiable rules, disallowed patterns, and a quality checklist. Every decision is specified — agents don't need to guess.
|
|
60
60
|
|
|
61
|
+
Packaging for agent tooling:
|
|
62
|
+
- **npm exports:** `remarque-tokens/agent-rules` (→ `AGENT_RULES.md`) and `remarque-tokens/spec` (→ `REMARQUE.md`), alongside the existing `remarque-tokens/tokens.json`, so a project can point an agent at `node_modules/remarque-tokens/AGENT_RULES.md` without hardcoding a filename.
|
|
63
|
+
- **Claude Code skill:** [`.claude/skills/remarque/SKILL.md`](.claude/skills/remarque/SKILL.md) — triggers on "remarque" / "design system" / new-page work, loads all three files, and states the tier rules, the audit command, and the two build-time pitfalls (unlayered-token-import, string-form `@import`) that pass a green build while silently breaking.
|
|
64
|
+
- **Live tokens endpoint:** the demo site serves the current `tokens.json` at **https://williamzujkowski.github.io/remarque/tokens.json** — a remote agent can fetch current token values directly instead of trusting training data.
|
|
65
|
+
|
|
61
66
|
## Files
|
|
62
67
|
|
|
63
68
|
| File | Purpose |
|
|
@@ -83,14 +88,17 @@ The agent rules define build order, non-negotiable rules, disallowed patterns, a
|
|
|
83
88
|
|
|
84
89
|
## Page Archetypes
|
|
85
90
|
|
|
86
|
-
Every page conforms to one of
|
|
91
|
+
Every page conforms to one of seven archetypes:
|
|
87
92
|
|
|
88
93
|
- **Essay** — long-form writing with serif title, mono metadata, narrow reading column
|
|
89
94
|
- **Project Dossier** — structured project page with metadata block and architecture section
|
|
90
95
|
- **Notebook** — short-form notes with mono timestamps, no cards
|
|
91
96
|
- **Landing** — identity statement, content navigation, generous whitespace
|
|
97
|
+
- **Reference/Docs** — persistent nav rail, breadcrumb kicker, prev/next footer (reuses Essay's three-column shape)
|
|
98
|
+
- **Changelog** — mono version/date headlines, grouped Added/Changed/Fixed lists (built from Notebook's entry structure)
|
|
99
|
+
- **Gallery** — cover-grid pages at `--content-wide`, covers exempt from the reading-width cap (formalized from tsundoku's reference implementation)
|
|
92
100
|
|
|
93
|
-
See the [live demo](https://williamzujkowski.github.io/remarque/) for
|
|
101
|
+
See the [live demo](https://williamzujkowski.github.io/remarque/) for the original four archetypes in action — Reference/Docs, Changelog, and Gallery are specified in REMARQUE.md but don't yet have a demo page in this repo.
|
|
94
102
|
|
|
95
103
|
## Design Decisions
|
|
96
104
|
|
package/REMARQUE.md
CHANGED
|
@@ -172,7 +172,7 @@ Never mix the two: a numeral inside running prose should never be tabular, and a
|
|
|
172
172
|
|
|
173
173
|
## Content Density Rule
|
|
174
174
|
|
|
175
|
-
No page should show more than three distinct content sections above the fold. The first screen of any page contains only: title, metadata, and the opening of content. Hero sections with CTAs, feature grids, and social proof are not part of Remarque's vocabulary.
|
|
175
|
+
No page should show more than three distinct content sections above the fold. The first screen of any page contains only: title, metadata, and the opening of content. Hero sections with CTAs, feature grids, and social proof are not part of Remarque's vocabulary. (The CLI-tool landing install block, see the Landing archetype, is a single command — not a CTA — and does not count against this rule.)
|
|
176
176
|
|
|
177
177
|
---
|
|
178
178
|
|
|
@@ -187,6 +187,28 @@ Remarque is typography-first, but projects include screenshots, architecture dia
|
|
|
187
187
|
- No rounded corners on images beyond `--radius-sm`
|
|
188
188
|
- Images are never decorative — every image must serve the content
|
|
189
189
|
|
|
190
|
+
### Plate (screenshot-heavy pages)
|
|
191
|
+
|
|
192
|
+
Reference/Docs and Project Dossier pages often need to show several screenshots — six or more UI captures walking through a workflow — where "one image at a time" doesn't scale. Plate is the sanctioned pattern; everything above still applies, it only adds:
|
|
193
|
+
|
|
194
|
+
- Default to single-column figures at `--content-reading` width, one screenshot per figure
|
|
195
|
+
- Every figure gets a numbered mono caption in the form `Fig. 01 — description` (`--font-mono`, `--text-meta`) — the number is mandatory once a page has more than one figure, so prose can cross-reference a specific plate
|
|
196
|
+
- A 2-up grid is permitted only for terminal/CLI captures, and only at `--content-standard` width — the one sanctioned exception to "images never wider than `--content-reading`," reserved for this narrow case
|
|
197
|
+
- A page with six or more plates gets prev/next figure navigation (mono, matching Reference/Docs' footer convention) rather than an unbroken scroll
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
## Dataviz Tokens
|
|
202
|
+
|
|
203
|
+
Charts are not yet a first-class Remarque surface, but tools built with the system inevitably need them. Rather than inventing chart-specific tokens, map dataviz elements onto vocabulary that already exists, so a chart survives a palette swap the same way prose and chrome do:
|
|
204
|
+
|
|
205
|
+
- **Grid lines** use `--color-border` — never a separate "chart gray." Grid lines are structural, not decorative, and already have a sanctioned quiet role.
|
|
206
|
+
- **Axis text and tick labels** use `--font-mono` at `--text-meta`, `--color-muted` — the same register as metadata rows and captions, never the body or display face.
|
|
207
|
+
- **Categorical color ramp** is derived, not hand-picked: rotate hue at the accent's lightness/chroma steps — the same discipline "Changing the Accent Hue" already prescribes (fix lightness, vary hue, reduce chroma until every value clears the gamut) — producing a small hue family distinct from `--color-accent` itself, so chart color is never mistaken for the system's one interactive signal.
|
|
208
|
+
- That ramp must be **audit-validated**, exactly like a palette override: every ramp color needs to clear gamut and 4.5:1 contrast against `--color-bg`/`--color-surface` in both themes before it ships.
|
|
209
|
+
|
|
210
|
+
**Precedent:** [tsundoku](https://github.com/williamzujkowski/tsundoku) built the underlying pattern already — its `DESIGN-NOTES.md` documents an 8-hue "orthogonal category system" (`--pop-pink`/`--pop-blue`/`--pop-green`/etc.), kept deliberately separate from `--color-accent` and used for content taxonomy (book categories, reading status) rather than interactivity. It held those hues to roughly the same lightness/contrast discipline as its audited palette, but by its own admission the hues were **never run through `remarque-audit`'s `CHECKS` array** — that is the one gap this guidance closes. A dataviz ramp should follow tsundoku's separation-from-accent instinct, but unlike its precedent, it must pass the audit before it ships.
|
|
211
|
+
|
|
190
212
|
---
|
|
191
213
|
|
|
192
214
|
## Motion Rules
|
|
@@ -324,7 +346,7 @@ This order is not a suggestion. It is the tiebreaker for every design decision.
|
|
|
324
346
|
|
|
325
347
|
## Page Archetypes
|
|
326
348
|
|
|
327
|
-
Every page built with Remarque must conform to one of these
|
|
349
|
+
Every page built with Remarque must conform to one of these seven archetypes: Essay, Project Dossier, Notebook, Landing, Reference/Docs, Changelog, Gallery. Agents and implementers should not invent new page structures — the last three exist precisely because real downstream projects (tsundoku, and the multi-site review that produced this revision) needed shapes the first four actively fought, and inventing an unsanctioned workaround is worse than extending the vocabulary here.
|
|
328
350
|
|
|
329
351
|
### Essay
|
|
330
352
|
|
|
@@ -396,6 +418,7 @@ The homepage or entry point. Sets the tone.
|
|
|
396
418
|
**Optionally includes:**
|
|
397
419
|
- Recent entries or updates (3–5 max)
|
|
398
420
|
- A brief "about" line
|
|
421
|
+
- **CLI-tool landing only:** a single mono install command block (styled as prose `<pre>`, copy button allowed) — the one sanctioned interactive element on an otherwise CTA-free page — and an optional `--help`-output figure (follows the Plate convention, see Image Treatment)
|
|
399
422
|
|
|
400
423
|
**Never includes:**
|
|
401
424
|
- Hero images or banners
|
|
@@ -404,6 +427,67 @@ The homepage or entry point. Sets the tone.
|
|
|
404
427
|
- Testimonial carousels
|
|
405
428
|
- Newsletter signup forms above the fold
|
|
406
429
|
|
|
430
|
+
The CLI install block is not a CTA exception in disguise — it is the single piece of information a CLI tool's landing page cannot omit (how do I get this), same status as a book's title. One block, one command, no surrounding marketing copy. A page with an install block *and* a separate "Sign up now" button has smuggled in a second CTA and fails this archetype.
|
|
431
|
+
|
|
432
|
+
### Reference/Docs
|
|
433
|
+
|
|
434
|
+
Persistent technical documentation: API references, config guides, multi-page manuals. Reuses the Essay archetype's existing three-column shape (nav rail outside the reading column · reading column · optional desktop ToC outside the reading column) — this is not a new layout engine, only a different left rail.
|
|
435
|
+
|
|
436
|
+
**Always includes:**
|
|
437
|
+
- A persistent left nav rail listing every doc page (mono, quiet, `--text-meta` — a list of links, not a component), sitting outside the reading column exactly like Essay's optional ToC sits outside it on the other side
|
|
438
|
+
- A breadcrumb kicker above the title (mono, `--text-meta`, e.g. `Reference / Configuration`)
|
|
439
|
+
- Content constrained to `--content-reading`, matching Essay's prose column
|
|
440
|
+
- A low-noise prev/next footer nav between adjacent doc pages (mono, matching Essay's footer nav)
|
|
441
|
+
|
|
442
|
+
**Optionally includes:**
|
|
443
|
+
- Tables and code blocks widening past the reading column to `--content-standard` when the content genuinely needs the room (a config reference table, a wide code sample) — the surrounding prose stays at `--content-reading`
|
|
444
|
+
- A desktop-only "on this page" ToC, reusing Essay's optional side-ToC convention, on the side opposite the nav rail
|
|
445
|
+
|
|
446
|
+
**Never includes:**
|
|
447
|
+
- Sidebar content mixed *into* the reading column itself (the nav rail is a fourth structural region, not reading-column content — same rule Essay already enforces for its own ToC)
|
|
448
|
+
- Card grids for the page listing (the nav rail is a list, not a grid of cards)
|
|
449
|
+
- More than one accent color
|
|
450
|
+
- CTAs, feature grids, or any Landing-archetype vocabulary
|
|
451
|
+
|
|
452
|
+
### Changelog
|
|
453
|
+
|
|
454
|
+
A tool or project's primary log of released changes. Built from the Notebook archetype's entry structure, not a new component: compact, mono-timestamped, content-forward entries, applied to version history instead of notes.
|
|
455
|
+
|
|
456
|
+
**Always includes:**
|
|
457
|
+
- A mono version + date headline per entry (e.g. `0.7.0 — 2026-07-21`) — semver renders as plain mono text, never a colored pill or badge
|
|
458
|
+
- Grouped category lists per entry (Added / Changed / Fixed, or whatever categories the project uses), reusing Notebook's compact entry rhythm
|
|
459
|
+
- Reverse-chronological order, most recent release first
|
|
460
|
+
|
|
461
|
+
**Optionally includes:**
|
|
462
|
+
- An inline mono link to the relevant issue/PR per line item
|
|
463
|
+
- A "compare" or diff link per version, mono, in the entry headline row
|
|
464
|
+
|
|
465
|
+
**Never includes:**
|
|
466
|
+
- Semver rendered as a pill/badge (`.rounded-full` chips, colored status pills) — plain mono text only, same rule as tags elsewhere in the system
|
|
467
|
+
- Card-based per-version layout
|
|
468
|
+
- Marketing framing of a change ("Exciting new feature!") — changelog prose stays as flat and factual as commit messages
|
|
469
|
+
|
|
470
|
+
A changelog embedded as an optional subsection of a Project Dossier (already sanctioned) remains valid for short update logs. Promote to the standalone Changelog archetype once the log is long enough, or important enough, to be the page rather than a section of one — typically once a tool ships its own versioned releases.
|
|
471
|
+
|
|
472
|
+
### Gallery
|
|
473
|
+
|
|
474
|
+
Cover-grid and catalog pages — a page whose primary content unit is a grid of images with a caption, not prose. None of the other archetypes are shaped for this: they are all fundamentally text/document-shaped. **Reference implementation: [tsundoku](https://github.com/williamzujkowski/tsundoku)**, which needed this shape immediately for its book-catalog `/browse` grid and documented it as an informal fifth archetype in its `DESIGN-NOTES.md` before this spec existed; Gallery formalizes that implementation rather than inventing a new one.
|
|
475
|
+
|
|
476
|
+
**Always includes:**
|
|
477
|
+
- A grid container widened beyond `--content-standard` (72rem) to `--content-wide` (88rem) — Gallery is the only archetype permitted to exceed `--content-standard`, because a grid of cover-aspect thumbnails needs more horizontal room before it feels cramped than an essay or a dossier ever would
|
|
478
|
+
- Cover/thumbnail images exempt from the `--content-reading` width cap that Image Treatment otherwise mandates — cover art *is* the content here, not illustrative decoration of prose. Every other Image Treatment rule still applies without exception: 1px `--color-border`, no drop shadow, mono captions
|
|
479
|
+
- Grid item hover restricted to a border-color shift only (`--motion-fast`) — no scale, no lift, no shadow growth, matching Motion Rules' general prohibition on attention-seeking animation
|
|
480
|
+
- Grid density driven by content (`repeat(auto-fill, minmax(...))` or breakpoint-based column counts), never a fixed card size that fights the image's native aspect ratio
|
|
481
|
+
|
|
482
|
+
**Optionally includes:**
|
|
483
|
+
- Prose-bearing sections within a Gallery page (an "about" blurb, an item description) narrowed back down to `--content-reading` — the widened container serves the grid only, not every element on the page
|
|
484
|
+
- Mono captions under each cover (title, author, or other item metadata)
|
|
485
|
+
|
|
486
|
+
**Never includes:**
|
|
487
|
+
- Card shadows or scale/lift-on-hover
|
|
488
|
+
- Masonry layouts (Notebook's existing prohibition applies here too — a fixed-ratio grid only)
|
|
489
|
+
- The `--content-wide` container used for anything other than the grid itself
|
|
490
|
+
|
|
407
491
|
---
|
|
408
492
|
|
|
409
493
|
## Signature Moves
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "remarque-tokens",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"engines": {
|
|
5
5
|
"node": ">=18"
|
|
6
6
|
},
|
|
@@ -47,6 +47,8 @@
|
|
|
47
47
|
"./prose.css": "./prose.css",
|
|
48
48
|
"./print": "./print.css",
|
|
49
49
|
"./print.css": "./print.css",
|
|
50
|
+
"./agent-rules": "./AGENT_RULES.md",
|
|
51
|
+
"./spec": "./REMARQUE.md",
|
|
50
52
|
"./package.json": "./package.json"
|
|
51
53
|
},
|
|
52
54
|
"files": [
|
package/tokens.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"$description": "Remarque design tokens — GENERATED from tokens-core.css + tokens-palette.css by scripts/tokens-json.mjs. Do not edit; the CSS is the source of truth.",
|
|
3
3
|
"$extensions": {
|
|
4
4
|
"remarque": {
|
|
5
|
-
"version": "0.
|
|
5
|
+
"version": "0.8.0",
|
|
6
6
|
"tiers": {
|
|
7
7
|
"core": "immutable identity — overriding forks the system",
|
|
8
8
|
"palette": "sanctioned personalization surface — override freely, then run remarque-audit"
|