Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ The Index is read, not browsed: a list under the house's own sentence, not a gri
| Published as | `meta` | `dim`, an App's Executable `ink`, a Library's Package `ink`; the Package is an underlined link at a 3px offset | |
| Links | `small`, each an underlined link at a 3px offset | `dim`; underline `dim` on hover | A column, `gap: 4px` |
| Install command box | `label` at line height 1.5, the Command colored by token ([content-model.md](content-model.md#command)), one line | `surface` background, 1px `rule` border, `rule-strong` on hover | `min-height: 44px`, `padding: 10px 12px`, full width of its column, the Command on the left and the icon on the right, 10px apart |
| Copy, Copied icon | The skill's UI icons, at their size | `dim`, `ink` while the box is hovered | |
| Copy, Copied icon | UI icons, drawn as [Copy and Copied icons](#copy-and-copied-icons) gives | `dim`, `ink` while the box is hovered | 14px |
| Example | | `surface` background, 1px `rule` border | `margin-top: 32px`, 12px in one column |
| Snippet header | `meta` | The name in the syntax `keyword` color, the language label in the syntax `comment` color | The name on the left and the label on the right (`space-between`, baseline, `gap: 16px`), `padding: 10px 16px`, a 1px `rule` below; a later Snippet's header also has one above |
| Snippet code | `code` | `ink`, colored by token with the syntax palette | `padding: 18px 16px 20px`; a File snippet has no left padding, because its line numbers take it |
Expand All @@ -197,6 +197,15 @@ Snippet code follows the text flow in the skill's `typography.md`; in a Terminal

The Install command fits its box on one line. `text-overflow: ellipsis` is a last resort: when a Command doesn't fit, adjust the box or the type instead.

### Copy and Copied icons

The two icons of the Install command box (rule 6). Each is drawn on `viewBox 0 0 16 16` by the stroke rules for UI icons in the skill's `iconography.md`.

| Icon | Use | Geometry |
| --- | --- | --- |
| Copy | Copies the Install command. | `<rect x="5.75" y="5.75" width="8.5" height="8.5"/>` and `<path d="M2.75 10.25V2.75h7.5"/>` |
| Copied | Replaces Copy for 1.2 s after a copy. | `<path d="M3 8.5l3.25 3.25L13 5"/>` |

## og:image

1200×630, PNG, one per page. Each is generated from its page's content, with the same fonts and Signs as the pages, never drawn by hand. It only changes when the content changes, so cache it.
Expand Down
5 changes: 3 additions & 2 deletions src/components/Icon.astro
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
// A UI icon, with the geometry and stroke rules of the skill's iconography.md: 16×16, shown at 14px,
// outlined in currentColor, aria-hidden. The control that holds it carries the accessible name.
// A UI icon, with the geometry of docs/design.md#copy-and-copied-icons and the stroke rules of the skill's
// iconography.md: 16×16, shown at 14px, outlined in currentColor, aria-hidden. The control that holds it
// carries the accessible name.
import type { HTMLAttributes } from "astro/types";

interface Props extends HTMLAttributes<"svg"> {
Expand Down
Loading