Repository navigation
docs: add brand guide for diagrams and graphics #955
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
1267584
docs: add brand guide for diagrams and graphics
moezdil cffe2f1
docs: align brand guide with website tokens
moezdil 5bcdd98
docs: document mermaid classes and font loading in brand guide
moezdil 4a14c16
docs: note code block font in brand guide
moezdil 868ad78
docs: add dark diagram tokens to brand guide
moezdil cd09779
docs: add draw.io option and clarify generated imagery in brand guide
moezdil File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| # HAMi Brand Guide | ||
|
|
||
| Visual rules for diagrams, slides and graphics that feature HAMi. Values come from the website tokens in [`src/css/custom.css`](src/css/custom.css) and the official [CNCF artwork](https://github.com/cncf/artwork/tree/main/projects/hami). | ||
|
|
||
| ## Colors | ||
|
|
||
| | Token | Hex | Use | | ||
| | --------------------- | --------- | ------------------------------------------- | | ||
| | Primary | `#10d05d` | Brand green: accents, key fills and strokes | | ||
| | Primary light / hover | `#35e37b` | Hover, lighter accent | | ||
| | Primary dark | `#0ebd54` | Pressed, depth | | ||
| | Primary darkest | `#08883b` | Deep green | | ||
| | Link | `#0a8f3d` | Green text on light backgrounds | | ||
| | Secondary | `#39c6f4` | Metrics, observability, info | | ||
| | Tertiary | `#7c8cff` | Scheduling, policy | | ||
| | Success | `#3ddc97` | Positive state | | ||
| | Warning | `#f5b942` | Attention | | ||
| | Danger | `#ff5c7a` | Errors | | ||
| | Text | `#15202b` | Body text | | ||
| | Heading | `#0f1722` | Headings | | ||
| | Muted | `#4f6378` | Secondary text, labels | | ||
| | Background | `#f5f8fb` | Canvas | | ||
| | Surface | `#ffffff` | Cards, nodes, panels | | ||
| | Border | `#d5dee8` | Borders, dividers | | ||
|
|
||
| Dark mode: `#0b0f14` (background), `#171e27` (surface), `#263241` (surface 3), `#f5f7fa` (text), `#2a3442` (border). The accent colors stay the same, and links use `#35e37b`. | ||
|
|
||
| `#10d05d` fails text contrast on white. Use it for fills and strokes, and `#0a8f3d` for green text. | ||
|
|
||
| Suggested diagram mapping: green for HAMi components, blue for observability, indigo for scheduling, neutrals for everything else. | ||
|
|
||
| ## Fonts | ||
|
|
||
| The font stacks are declared in `custom.css` as `--hami-font-display`, `--hami-font-body` and `--hami-font-mono`. The site does not bundle or load the named web fonts, so in practice browsers render the fallbacks. Code blocks currently use the Infima default monospace stack instead of `--hami-font-mono`. Reference the same stacks in SVGs and graphics. | ||
|
|
||
| | Role | Font | Fallback | | ||
| | --------------- | ------------- | ------------------------------------- | | ||
| | Headings | Space Grotesk | "Avenir Next", "Segoe UI", sans-serif | | ||
| | Body and labels | Source Sans 3 | "Noto Sans", "Segoe UI", sans-serif | | ||
| | Code, YAML, CLI | IBM Plex Mono | "SFMono-Regular", Consolas, monospace | | ||
|
|
||
| ## Logo | ||
|
|
||
| - Use the official SVGs from the [CNCF artwork repo](https://github.com/cncf/artwork/tree/main/projects/hami) (copies live in `static/img/`, e.g. `hami-graph-color.svg`). Never redraw the melon or retype the "HAMi" wordmark. | ||
| - The official color logo is filled `#0FD05D`, which matches the website primary `#10d05d` closely. Do not recolor the logo. | ||
| - There is no full-color wordmark lockup. Use the color icon alone, or a black or white lockup. | ||
| - Black or color variant on light backgrounds, white variant on dark ones. | ||
| - Keep the aspect ratio. No gradients, shadows, strokes or skewing. | ||
| - Minimum size: icon 24px tall, horizontal lockup 100px wide, stacked lockup 64px wide. | ||
|
|
||
| HAMi and the HAMi logo are trademarks of The Linux Foundation. See the [trademark usage guidelines](https://www.linuxfoundation.org/legal/trademark-usage). | ||
|
|
||
| ## Diagrams | ||
|
|
||
| Mermaid is the preferred format, so visuals stay easy to update. The site themes it through `custom.css`: add `class NodeA accent` (or `info`, `run`, `ok`, `bad`) and the node picks up the light or dark colors automatically. | ||
|
|
||
| | Class | Light fill / stroke | Dark fill / stroke | Meaning | | ||
| | -------- | --------------------- | --------------------- | ----------- | | ||
| | `accent` | `#d9f99d` / `#4f7d00` | `#365314` / `#a3e635` | HAMi | | ||
| | `info` | `#dbeafe` / `#1a5fb4` | `#1e3a5f` / `#60a5fa` | Information | | ||
| | `run` | `#fef3c7` / `#b45309` | `#78350f` / `#fbbf24` | Running | | ||
| | `ok` | `#dcfce7` / `#0b6b3c` | `#14532d` / `#4ade80` | Success | | ||
| | `bad` | `#fee2e2` / `#b3261e` | `#7f1d1d` / `#f87171` | Error | | ||
|
|
||
| Add a caption with `%% title: <text>` as the first line inside the mermaid fence. | ||
|
|
||
| For hand-written SVG: | ||
|
|
||
| - Use the colors above, the same font stacks, and the diagram panel tokens in `custom.css` (`--hami-diagram-*`): heading `#15324d`, body `#1a3956`, muted `#5a748f`, connectors `#39c6f4` at low opacity. | ||
|
moezdil marked this conversation as resolved.
Resolved
|
||
| - Keep the palette consistent in light and dark mode. The site defaults to dark. | ||
| - No animated or decorative generated imagery. | ||
|
moezdil marked this conversation as resolved.
Resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.