polyxd 0.2.2 → 0.4.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.
Files changed (3) hide show
  1. package/NOTICE +45 -0
  2. package/README.md +3 -0
  3. package/package.json +2 -2
package/NOTICE CHANGED
@@ -135,6 +135,51 @@ Upstream: https://github.com/adobe/spectrum-tokens
135
135
 
136
136
  Vendored under `packages/ds-spectrum/scripts/sources/`, with the upstream licence file beside it.
137
137
 
138
+ ## Logos
139
+
140
+ Twelve packs ship their design system's official logo, unaltered, as `logo.svg`
141
+ (Bootstrap and Radix also ship the owner's white version as `logo-white.svg`),
142
+ downloaded from the owner's own site, repository or brand page. Where a design
143
+ system has no mark of its own (Polaris, Spectrum, Primer), the pack ships its
144
+ company's logo. Each is used only to identify the design system a pack is
145
+ modelled on, beside its name. The logos are trademarks of their owners, not
146
+ Polyxd's, and are not covered by Polyxd's licence:
147
+
148
+ - Material 3 (`@polyxd/ds-material3`) — Google LLC
149
+ - Carbon (`@polyxd/ds-carbon`) — IBM Corp.
150
+ - Fluent 2 (`@polyxd/ds-fluent`) — Microsoft Corporation
151
+ - Polaris (`@polyxd/ds-polaris`) — the Shopify logo, Shopify Inc.
152
+ - Spectrum 2 (`@polyxd/ds-spectrum`) — the Adobe logo, Adobe Inc.
153
+ - Primer (`@polyxd/ds-primer`) — the GitHub logo, GitHub, Inc.
154
+ - shadcn/ui (`@polyxd/ds-shadcn`) — shadcn
155
+ - Ant Design (`@polyxd/ds-antd`) — Ant Group
156
+ - Bootstrap (`@polyxd/ds-bootstrap`) — the Bootstrap team
157
+ - Chakra UI (`@polyxd/ds-chakra`) — Chakra Systems Inc.
158
+ - Mantine (`@polyxd/ds-mantine`) — Vitaly Rtishchev
159
+ - Radix UI (`@polyxd/ds-radix`) — WorkOS
160
+
161
+ Google, IBM, Microsoft, Shopify, Adobe and GitHub restrict the use of their
162
+ logos without permission; each pack's manifest (`logo`) and README record the
163
+ source and the owner's guidelines. GOV.UK's crown and logotype are protected and
164
+ may not be used by a service that is not on GOV.UK, so `@polyxd/ds-govuk` ships
165
+ no logo and is named in words only.
166
+
167
+ The twelve template packs' `logo.svg` files are Polyxd's own marks, drawn from
168
+ each template's tokens.
169
+
170
+ ## Template packs
171
+
172
+ Twelve packs are original Polyxd templates, not readings of any design system:
173
+ `@polyxd/ds-sketch`, `@polyxd/ds-wireframe`, `@polyxd/ds-editorial`,
174
+ `@polyxd/ds-brutalist`, `@polyxd/ds-glass`, `@polyxd/ds-terminal`,
175
+ `@polyxd/ds-pastel`, `@polyxd/ds-civic`, `@polyxd/ds-finance`,
176
+ `@polyxd/ds-health`, `@polyxd/ds-neon` and `@polyxd/ds-mono`. Every value in
177
+ them was chosen for the template, they vendor nothing, and they are Apache-2.0
178
+ like the rest of Polyxd. The typefaces some of them name (Caveat, Patrick Hand,
179
+ Fraunces, Nunito, JetBrains Mono, Space Grotesk) are under the SIL Open Font
180
+ License and are loaded from Google Fonts by the page that uses them, never
181
+ distributed here.
182
+
138
183
  ## Specification
139
184
 
140
185
  ### A2UI
package/README.md CHANGED
@@ -4,8 +4,11 @@
4
4
  npx polyxd pack ./src/tokens.css # a Polyxd pack from your design system's tokens
5
5
  npx polyxd check ./ds-acme/manifest.json
6
6
  POLYXD_STUDIO_KEY=… npx polyxd studio push ./ --to https://studio.polyxd.com/api/w/acme
7
+ npx polyxd dev ./screens # preview the documents in a folder as you edit them
7
8
  ```
8
9
 
9
10
  `pack` reads your CSS custom properties (or a DTCG JSON file), maps what it can onto Polyxd's semantic token contract, and writes a pack plus a mapping file recording every guess. It reports what's still missing and any of your own colour pairs that fail contrast. `check` validates a pack against the contract. `studio push` sends a token package (packed with npm, so private registries never matter), a tarball or a single token file to Polyxd Studio as a new version of your design system; made for a CI step on every release, with an API key from Studio's Team page.
10
11
 
12
+ `dev` watches a folder of documents and serves a page that renders the selected one with the real renderer in any built-in pack (or yours, with `--pack`), light or dark, phone to desktop, with the static check, the document, its data and the actions it dispatches beside it; it reloads in place on save. `--verify` adds a button that runs the full verifier when `@polyxd/verifier` is installed.
13
+
11
14
  [How it guesses](https://polyxd.com/docs/your-design-system/) · [Polyxd](https://polyxd.com) · [Source](https://github.com/visualfart/polyxd)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "polyxd",
3
- "version": "0.2.2",
3
+ "version": "0.4.0",
4
4
  "description": "The polyxd command: make a Polyxd design-system pack from your own tokens, and check it against the contract",
5
5
  "license": "Apache-2.0",
6
6
  "type": "module",
@@ -14,7 +14,7 @@
14
14
  "NOTICE"
15
15
  ],
16
16
  "dependencies": {
17
- "@polyxd/ds-kit": "^0.2.2"
17
+ "@polyxd/ds-kit": "^0.4.0"
18
18
  },
19
19
  "repository": {
20
20
  "type": "git",