Skip to content

Commit f920280

Browse files
authored
Even more docs fixes (#40)
1 parent 7cbee1d commit f920280

File tree

10 files changed

+26
-22
lines changed

10 files changed

+26
-22
lines changed

docs/src/components/CobaltSm.astro

+6-2
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,20 @@
22
@use '../../tokens' as *;
33

44
.box {
5-
--size: 1.625rem;
5+
--size: 1.25rem;
66
align-items: flex-end;
77
background-color: token('color.blue.50');
8+
border: 1px solid token('color.ui.contrast.0');
9+
box-sizing: content-box;
810
color: token('color.white');
911
display: flex;
1012
font-size: 0.75rem;
1113
font-weight: 500;
12-
line-height: 0.8;
1314
height: var(--size);
1415
justify-content: flex-end;
16+
line-height: 0.8;
17+
margin-left: -1px; // account for border
18+
margin-top: -1px; // account for border
1519
padding: 0.25rem;
1620
width: var(--size);
1721
}

docs/src/pages/docs/plugins/css.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Automatically generates 🌈 [**P3 colors**](https://developer.mozilla.org/en-US
1111

1212
## Setup
1313

14-
```
14+
```bash
1515
npm i -D @cobalt-ui/plugin-css
1616
```
1717

docs/src/pages/docs/plugins/js.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ layout: ../../../layouts/docs.astro
77

88
Generate JS, TS, and JSON output from design tokens.
99

10-
```
10+
```bash
1111
npm i -D @cobalt-ui/plugin-js
1212
```
1313

docs/src/pages/docs/plugins/sass.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Generate Sass output for [Cobalt](https://cobalt-ui.pages.dev) from design token
99

1010
## Setup
1111

12-
```
12+
```bash
1313
npm i -D @cobalt-ui/plugin-sass
1414
```
1515

docs/src/pages/docs/reference/about.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,17 @@ layout: ../../../layouts/docs.astro
77

88
## Project Goals
99

10-
The project goals are subject to change, but currently are encompassed by 3 points:
11-
1210
1. Support the complete and full [W3C Design Tokens CG spec](https://design-tokens.github.io/community-group/format)
13-
2. Maintain a pluggable interface, where users can write their own plugins or the community can contribute plugins
14-
3. Make syncing from Figma easy and automatable
11+
2. Support a pluggable and configurable architecture, enabling users and the community to write their own plugins to generate any format
12+
3. Make syncing from Figma easy and automatable ([docs](/docs/guides/tokens-studio))
1513

1614
## Why the name “Cobalt”?
1715

1816
The name **Cobalt** has three meanings:
1917

20-
1. Cobalt is an [element on the periodic table](https://en.wikipedia.org/wiki/Cobalt) in reference to design tokens being the “atoms” of design systems.
21-
2. Just as blue pigment (cobalt or ultramarine) was [the last “missing piece“ in paint colors](https://artuk.org/discover/stories/colour-in-art-a-brief-history-of-blue-pigment), having an easy-to-use system to manage design tokens aims to be the “missing piece” to design management.
22-
3. Blue is also a reference to a [blueprint](https://en.wikipedia.org/wiki/Blueprint) that acts as the reference for a design system.
18+
1. Cobalt [the element](https://en.wikipedia.org/wiki/Cobalt) is a nod to design tokens being the “atoms” of your design system<br />
19+
_Fun fact: the crystalline structure of Cobalt is hexagonal_
20+
2. Cobalt [the pigment](https://artsartistsartwork.com/history-of-the-colour-blue-in-art/) is a nod to blue being the last missing color in art history, just as design tokens are the last missing piece of design systems<br />
21+
_Fun fact: Van Gogh once said “Cobalt is a divine colour and there is nothing so beautiful for putting atmosphere around things”_
22+
3. Cobalt the color is a nod to [blueprints](https://en.wikipedia.org/wiki/Blueprint)<br />
23+
_Fun fact: blueprints originally were colored with Prussian Blue (ferrous ferrocyanide), not Cobalt, for cost reasons_

docs/src/pages/docs/reference/config.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ To load tokens from an npm package, update `config.tokens` to point to the **ful
3131

3232
## Syncing with Figma
3333

34-
You can sync tokens with Figma by using the [Tokens Studio for Figma](../guides/tokens-studio) plugin.
34+
You can sync tokens with Figma by using the [Tokens Studio for Figma](/docs/guides/tokens-studio) plugin.
3535

3636
## Plugins
3737

3838
Each plugin comes with its own rules and setup. Follow the corresponding plugin guide to enable code generation:
3939

40-
👉 **[View plugins](../plugins)**
40+
👉 **[View plugins](/docs/plugins)**

docs/src/pages/docs/tokens/index.astro

+4-5
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,16 @@ const tokenDef = {
2626
<h1>Tokens</h1>
2727

2828
<p>
29-
Tokens are defined via the <a href="https://design-tokens.github.io/community-group/format/" target="_blank">the W3C Design Tokens format</a> schema (Apr 2023). Cobalt aims to supports 100% of the spec as-outlined, but with the following
30-
known extensions:
29+
Tokens are defined via the <a href="https://design-tokens.github.io/community-group/format/" target="_blank">the W3C Design Tokens format</a> schema (Apr 2023). Cobalt supports 100% of the spec, but with the following changes:
3130
</p>
3231

3332
<ul>
34-
<li>Cobalt supports the <a href="#link">link</a> type</li>
33+
<li>Cobalt supports assets via the <a href="#link">link</a> type</li>
3534
<li>Cobalt introduces the concept of <a href="#modes">Modes</a></li>
36-
<li>While the spec technically prohibits unknown keys or properties; Cobalt ignores them.</li>
35+
<li>Cobalt ignores unknown properties rather than throwing errors as the spec requires.</li>
3736
</ul>
3837

39-
<p>Any other deviations can be treated as unintentional (so please <a href="https://github.com/drwpow/cobalt-ui/issues">file an issue!</a>).</p>
38+
<p>Any other deviations can be treated as unintentional (please <a href="https://github.com/drwpow/cobalt-ui/issues">file an issue!</a>).</p>
4039

4140
<h2 id="color">
4241
<Token type="color" />

packages/plugin-css/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Automatically generates 🌈 [**P3 colors**](https://developer.mozilla.org/en-US
66

77
## Setup
88

9-
```
9+
```bash
1010
npm i -D @cobalt-ui/plugin-css
1111
```
1212

packages/plugin-js/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Generate JS, TS, and JSON output from design tokens.
44

5-
```
5+
```bash
66
npm i -D @cobalt-ui/plugin-js
77
```
88

packages/plugin-sass/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Generate Sass output for [Cobalt](https://cobalt-ui.pages.dev) from design token
44

55
## Setup
66

7-
```
7+
```bash
88
npm i -D @cobalt-ui/plugin-sass
99
```
1010

0 commit comments

Comments
 (0)