Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update docs with new font struct #355

Merged
merged 1 commit into from
Jul 9, 2021
Merged

Update docs with new font struct #355

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 22 additions & 4 deletions TerminalDocs/customize-settings/profile-appearance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,19 @@ This is the name of the color scheme used in the profile. Color schemes are defi

**Default value:** `"Campbell"`

### Font face
### Font

This is the structure within which the other font settings must be defined. An example of what this could look like in the JSON file is shown below.

**Property name:** `font`

**Necessity:** Optional

### Font Face

This is the name of the font face used in the profile. The terminal will try to fallback to Consolas if this can't be found or is invalid. To learn about the other variants of the default font, Cascadia Mono, visit the [Cascadia Code page](./../cascadia-code.md).

**Property name:** `fontFace`
**Property name:** `face` (defined within the `font` object)

**Necessity:** Optional

Expand All @@ -53,7 +61,7 @@ This is the name of the font face used in the profile. The terminal will try to

This sets the profile's font size in points.

**Property name:** `fontSize`
**Property name:** `size` (defined within the `font` object)

**Necessity:** Optional

Expand All @@ -65,14 +73,24 @@ This sets the profile's font size in points.

This sets the weight (lightness or heaviness of the strokes) for the profile's font.

**Property name:** `fontWeight`
**Property name:** `weight` (defined within the `font` object)

**Necessity:** Optional

**Accepts:** `"normal"`, `"thin"`, `"extra-light"`, `"light"`, `"semi-light"`, `"medium"`, `"semi-bold"`, `"bold"`, `"extra-bold"`, `"black"`, `"extra-black"`, or an integer corresponding to the numeric representation of the OpenType font weight

**Default value:** `"normal"`

### Font example

```json
"font": {
"face": "Cascadia Mono",
"size": 12,
"weight": "normal"
}
```

## Retro terminal effects

:::row:::
Expand Down