Skip to content

Commit 416e068

Browse files
authored
Minor styling.md text updates (#135)
- Add hash requirement mention in styling guideline and add hashes to example .yaml - Also rename colour to color since we've previously decided we're going with U.S. spelling - Update link to tinted-vim
1 parent 72800b0 commit 416e068

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

styling.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ _The original version of this spec can be found at [chriskempson/base16](https:/
55
# Base16 Styling Guidelines
66
**Version 0.4.2**
77

8-
Base16 aims to group similar language constructs with a single color. For example, floats, ints, and doubles would belong to the same colour group. The colors for the default scheme were chosen to be easily separable, but scheme designers should pick whichever colours they desire, e.g. `base0B` (green by default) could be replaced with red. There are, however, some general guidelines below that stipulate which `base0B` should be used to highlight each construct when designing templates for editors.
8+
Base16 aims to group similar language constructs with a single color. For example, floats, ints, and doubles would belong to the same color group. The colors for the default scheme were chosen to be easily separable, but scheme designers should pick whichever colors they desire, e.g. `base0B` (green by default) could be replaced with red. There are, however, some general guidelines below that stipulate which `base0B` should be used to highlight each construct when designing templates for editors.
99

1010
Since describing syntax highlighting can be tricky, please see [base16-vim](https://github.com/tinted-theming/base16-vim/) and [base16-emacs](https://github.com/tinted-theming/base16-emacs/) for reference. Though it should be noted that each editor will have some discrepancies due the fact that editors generally have different syntax highlighting engines.
1111

12-
Colors `base00` to `base07` are typically variations of a shade and run from darkest to lightest for dark themes. These colors are used for foreground and background, status bars, line highlighting and such. Colors `base08` to `base0F` are typically individual colors used for types, operators, names and variables. In order to create a dark scheme, colors `base00` to `base07` should span from dark to light. For a light scheme, these colours should span from light to dark.
12+
Colors `base00` to `base07` are typically variations of a shade and run from darkest to lightest for dark themes. These colors are used for foreground and background, status bars, line highlighting and such. Colors `base08` to `base0F` are typically individual colors used for types, operators, names and variables. In order to create a dark scheme, colors `base00` to `base07` should span from dark to light. For a light scheme, these color should span from light to dark.
1313

1414
## Usage Guidelines
1515

1616
We offer guidelines for both dark and light themes:
1717

1818
### Dark
1919

20-
- Colours from `base00` to `base07` should range from dark to light.
20+
- Colors from `base00` to `base07` should range from dark to light.
2121

2222
### Light
2323

24-
- Colours from `base00` to `base07` should range from light to dark.
24+
- Colors from `base00` to `base07` should range from light to dark.
2525

26-
## Specific Colours and Their Usages
26+
## Specific Colors and Their Usages
2727

28-
Each colour (base0X) serves a specific purpose or use case, such as background, foreground, variables, errors, etc. Here's a breakdown using the "One Dark" scheme colors:
28+
Each color (base0X) serves a specific purpose or use case, such as background, foreground, variables, errors, etc. Here's a breakdown using the "One Dark" scheme colors:
2929

3030
| Color | base0X | ANSI | Terminal | Text Editor |
3131
| -------------------------------------------------- | ------- | -------- | -------------------------- | ----------- |
@@ -49,7 +49,7 @@ We offer guidelines for both dark and light themes:
4949
**Notes**:
5050

5151
- These are just guidelines and will most often provide best results when the they are followed.
52-
- Items in parenthesis in the Terminal column do not have an identified terminal use and are a more generic colour description.
52+
- Items in parenthesis in the Terminal column do not have an identified terminal use and are a more generic color description.
5353
- Most terminals allow to set extended ANSI colors, but not all. It can't be assumed that the extended ANSI colors are set when using a tinted-theming terminal template theme.
5454

5555
## YAML scheme example
@@ -62,22 +62,22 @@ name: "Ayu Dark"
6262
author: "Khue Nguyen <Z5483Y@gmail.com>"
6363
variant: "dark"
6464
palette:
65-
base00: "0f1419" # ---- dark
66-
base01: "131721" # ---
67-
base02: "272d38" # --
68-
base03: "3e4b59" # -
69-
base04: "bfbdb6" # +
70-
base05: "e6e1cf" # ++
71-
base06: "e6e1cf" # +++
72-
base07: "f3f4f5" # ++++ light
73-
base08: "f07178" # red
74-
base09: "ff8f40" # orange
75-
base0A: "ffb454" # yellow
76-
base0B: "b8cc52" # green
77-
base0C: "95e6cb" # cyan
78-
base0D: "59c2ff" # blue
79-
base0E: "d2a6ff" # purple
80-
base0F: "e6b673" # brown
65+
base00: "#0f1419" # ---- dark
66+
base01: "#131721" # ---
67+
base02: "#272d38" # --
68+
base03: "#3e4b59" # -
69+
base04: "#bfbdb6" # +
70+
base05: "#e6e1cf" # ++
71+
base06: "#e6e1cf" # +++
72+
base07: "#f3f4f5" # ++++ light
73+
base08: "#f07178" # red
74+
base09: "#ff8f40" # orange
75+
base0A: "#ffb454" # yellow
76+
base0B: "#b8cc52" # green
77+
base0C: "#95e6cb" # cyan
78+
base0D: "#59c2ff" # blue
79+
base0E: "#d2a6ff" # purple
80+
base0F: "#e6b673" # brown
8181
```
8282
8383
_SPEC END_

0 commit comments

Comments
 (0)