@whatsaaaa/design-system 0.2.0 → 0.3.1
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/LICENSE +0 -30
- package/README.md +11 -36
- package/assets/manifest.json +6 -0
- package/assets/whatsaaaa/profile-banner.png +0 -0
- package/docs/usage.md +1 -0
- package/licenses/README.md +2 -0
- package/package.json +2 -2
package/LICENSE
CHANGED
|
@@ -1,33 +1,3 @@
|
|
|
1
|
-
Except for the Whatsaaaa identity artwork and the third-party material named
|
|
2
|
-
below, the contents of this repository, the design tokens, the stylesheets, the
|
|
3
|
-
scripts, the <ws-ghost> element, the theme, shortcut and code-theme modules and
|
|
4
|
-
the docs theme among them, are provided under the MIT License that follows.
|
|
5
|
-
|
|
6
|
-
The Whatsaaaa identity artwork is excluded from the MIT License. It is
|
|
7
|
-
Copyright (c) 2026 Whatsaaaa, all rights reserved. It is the ghost, the
|
|
8
|
-
wordmark, the lockups and marks, the sprite and mark of each project, the README
|
|
9
|
-
headers, the social cards and the favicons, as the generated files in `assets/`,
|
|
10
|
-
as the drawings encoded in `src/identity/` and `identity/`, and as those
|
|
11
|
-
drawings compiled into the package in `dist/identity/` and `dist/ghost/`. The
|
|
12
|
-
code that turns those drawings into files and markup is under the MIT License;
|
|
13
|
-
the drawings are not.
|
|
14
|
-
|
|
15
|
-
The artwork may be redistributed unmodified as part of this package and of
|
|
16
|
-
builds made with it, as the <ws-ghost> element and the docs theme carry it. It
|
|
17
|
-
may not be displayed, used as a logo or mark, or used to identify anything other
|
|
18
|
-
than Whatsaaaa and its projects. The MIT License covers the code of <ws-ghost>
|
|
19
|
-
and of the docs theme, not the ghost they draw. A site that is not Whatsaaaa's
|
|
20
|
-
own and uses either of them makes sure the ghost is not shown on it: it puts
|
|
21
|
-
neither <ws-ghost> nor the output of `ghostSvg` or `ghostMarkup` on its pages,
|
|
22
|
-
and in the docs theme it replaces the theme's `NavGhost.vue` and `NotFound.vue`
|
|
23
|
-
with its own components, the way VitePress overrides an internal component of a
|
|
24
|
-
theme, with a Vite alias.
|
|
25
|
-
|
|
26
|
-
Third-party material keeps its own license: the Rosé Pine palette (MIT) and the
|
|
27
|
-
Departure Mono glyphs (SIL Open Font License 1.1), in `licenses/`, and the
|
|
28
|
-
JetBrains Mono and Inter fonts (SIL Open Font License 1.1), whose licenses the
|
|
29
|
-
build copies next to them in `dist/fonts/`.
|
|
30
|
-
|
|
31
1
|
MIT License
|
|
32
2
|
|
|
33
3
|
Copyright (c) 2026 Whatsaaaa
|
package/README.md
CHANGED
|
@@ -8,14 +8,14 @@ The package is [`@whatsaaaa/design-system`](https://www.npmjs.com/package/@whats
|
|
|
8
8
|
|
|
9
9
|
## What is in it
|
|
10
10
|
|
|
11
|
-
| Part | What it is
|
|
12
|
-
| ----------------------- |
|
|
13
|
-
| Identity | The ghost in every cut, the wordmark, six poses, a sprite per project, favicons, README headers and
|
|
14
|
-
| Tokens | Rosé Pine main for dark and Dawn for light, mapped to roles, with type, space, radii and motion
|
|
15
|
-
| Styles | Prose, code blocks, tables, lists, callouts, and the terminal frame: tab bar, prompts, status line
|
|
16
|
-
| The ghost as an element | `<ws-ghost>`, with the easter egg
|
|
17
|
-
| Docs theme | A VitePress theme on top of VitePress's default theme
|
|
18
|
-
| Style guide | A site that shows all of it with real content, in dark and light, and offers the assets for download
|
|
11
|
+
| Part | What it is | Source |
|
|
12
|
+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
|
|
13
|
+
| Identity | The ghost in every cut, the wordmark, six poses, a sprite per project, favicons, README headers, social cards and a profile banner. All generated | `src/identity/ghost.ts`, `identity/` |
|
|
14
|
+
| Tokens | Rosé Pine main for dark and Dawn for light, mapped to roles, with type, space, radii and motion | `tokens/` |
|
|
15
|
+
| Styles | Prose, code blocks, tables, lists, callouts, and the terminal frame: tab bar, prompts, status line | `src/css/` |
|
|
16
|
+
| The ghost as an element | `<ws-ghost>`, with the easter egg | `src/ghost/` |
|
|
17
|
+
| Docs theme | A VitePress theme on top of VitePress's default theme | `src/vitepress/`, `src/vitepress-config/` |
|
|
18
|
+
| Style guide | A site that shows all of it with real content, in dark and light, and offers the assets for download | `styleguide/` |
|
|
19
19
|
|
|
20
20
|
To use it in another project, install it with `pnpm add @whatsaaaa/design-system` and read [docs/usage.md](./docs/usage.md). It is written for coding agents and is short.
|
|
21
21
|
|
|
@@ -121,31 +121,6 @@ The licenses are in [`licenses/`](./licenses/).
|
|
|
121
121
|
|
|
122
122
|
## License
|
|
123
123
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
The
|
|
127
|
-
|
|
128
|
-
The artwork may be redistributed unmodified as part of this package and of builds made with it. It may not be shown, used as a logo or mark, or used to identify anything other than Whatsaaaa and its projects. That covers the ghost that `<ws-ghost>` and the docs theme draw: the MIT License covers their code, not the ghost. A site that is not Whatsaaaa's own makes sure the ghost is not shown on it. It puts neither `<ws-ghost>` nor the output of `ghostSvg` or `ghostMarkup` on its pages, and with the docs theme it replaces the theme's `NavGhost.vue` and `NotFound.vue`, the way VitePress [overrides an internal component](https://vitepress.dev/guide/extending-default-theme#overriding-internal-components):
|
|
129
|
-
|
|
130
|
-
```ts
|
|
131
|
-
// .vitepress/config.ts
|
|
132
|
-
import { fileURLToPath, URL } from 'node:url'
|
|
133
|
-
|
|
134
|
-
export default defineConfigWithTheme<ThemeConfig>({
|
|
135
|
-
extends: whatsaaaaConfig(),
|
|
136
|
-
vite: {
|
|
137
|
-
resolve: {
|
|
138
|
-
alias: [
|
|
139
|
-
{
|
|
140
|
-
find: /^.*\/components\/NavGhost\.vue$/,
|
|
141
|
-
replacement: fileURLToPath(new URL('./theme/SiteMark.vue', import.meta.url)),
|
|
142
|
-
},
|
|
143
|
-
{
|
|
144
|
-
find: /^.*\/components\/NotFound\.vue$/,
|
|
145
|
-
replacement: fileURLToPath(new URL('./theme/SiteNotFound.vue', import.meta.url)),
|
|
146
|
-
},
|
|
147
|
-
],
|
|
148
|
-
},
|
|
149
|
-
},
|
|
150
|
-
})
|
|
151
|
-
```
|
|
124
|
+
Everything made for Whatsaaaa here is [MIT](./LICENSE), the identity artwork included: the tokens, the stylesheets, the scripts, `<ws-ghost>`, the theme, shortcut and code-theme modules, the docs theme, and the ghost, the wordmark, the lockups and marks, the sprite and mark of each project, the README headers, the social cards, the profile banner and the favicons.
|
|
125
|
+
|
|
126
|
+
The third-party material in the [credits](#credits) keeps its own license: the Rosé Pine palette is MIT, and the Departure Mono glyph outlines and the JetBrains Mono and Inter fonts are under the SIL Open Font License 1.1.
|
package/assets/manifest.json
CHANGED
|
@@ -187,6 +187,12 @@
|
|
|
187
187
|
"width": 1280,
|
|
188
188
|
"height": 640,
|
|
189
189
|
"use": "Social card as an image, the size link previews ask for."
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
"file": "profile-banner.png",
|
|
193
|
+
"width": 1280,
|
|
194
|
+
"height": 288,
|
|
195
|
+
"use": "The profile banner as an image, at twice its size. Upload this one to Gravatar."
|
|
190
196
|
}
|
|
191
197
|
],
|
|
192
198
|
"building-blocks": [
|
|
Binary file
|
package/docs/usage.md
CHANGED
|
@@ -225,6 +225,7 @@ Generated files are in `assets/<name>/`, for `whatsaaaa` and for each project. `
|
|
|
225
225
|
| Logo with name | `lockup-dark.svg`, `lockup-light.svg` |
|
|
226
226
|
| Top of a README | `readme-header.svg` |
|
|
227
227
|
| Link preview | `social-card.png` |
|
|
228
|
+
| Gravatar header | `profile-banner.png` (handle only). Profile colors: dark `bg`, `surface`, `interactive` |
|
|
228
229
|
|
|
229
230
|
Copy the files you need into the project. Show a mark at 16, 32, 48 or 64 px, where its pixels are sharp.
|
|
230
231
|
|
package/licenses/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# Licenses of what the system builds on
|
|
2
2
|
|
|
3
|
+
The design system is under the MIT License, in [`LICENSE`](../LICENSE). The third-party material below keeps its own license.
|
|
4
|
+
|
|
3
5
|
| What | License | Where it is used | File |
|
|
4
6
|
| --- | --- | --- | --- |
|
|
5
7
|
| Rosé Pine palette, from `@rose-pine/palette` | MIT, Copyright (c) mvllow | The color values in `tokens/palette.tokens.json` and everything built from them | `rose-pine-palette.LICENSE` |
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@whatsaaaa/design-system",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "Whatsaaaa's design system: brand identity, design tokens, typography, docs theme and asset kit",
|
|
5
5
|
"homepage": "https://github.com/whatsaaaa/design-system#readme",
|
|
6
6
|
"bugs": "https://github.com/whatsaaaa/design-system/issues",
|
|
7
|
-
"license": "
|
|
7
|
+
"license": "(MIT AND OFL-1.1)",
|
|
8
8
|
"author": "Whatsaaaa",
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|