You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+44-24Lines changed: 44 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Monaspace
2
2
3
-
The Monaspace type system: a monospaced type superfamily with some modern tricks up its sleeves. It is comprised of five variable axis typefaces. Each one has a distinct voice, but they are all metrics-compatible with one another, allowing you to mix and match them for a more expressive typographical palette.
3
+
The Monaspace type system is a monospaced type superfamily with some modern tricks up its sleeve. It consists of five variable axis typefaces. Each one has a distinct voice, but they are all metrics-compatible with one another, allowing you to mix and match them for a more expressive typographical palette.
4
4
5
5
Letters on a grid is how we see our code. Why not make those letters better?
6
6
@@ -13,18 +13,18 @@ Letters on a grid is how we see our code. Why not make those letters better?
13
13
14
14
## Overview
15
15
16
-
Monaspace is made available as both a variable-axis font and as static builds. You can install them both side-by-side; their family names are distinct. For example:
16
+
Monaspace is available as a variable-axis font and a static build. You can install them both side-by-side; their family names are distinct. For example:
17
17
18
18
-`Monaspace _____`: the static family
19
19
-`Monaspace _____ Var` or `VF`: the variable family
20
20
21
-
The variable fonts have one file per family (Neon, Argon, etc). Modern and convenient!
21
+
The variable fonts have one file per family (Neon, Argon, etc.). Modern and convenient!
22
22
23
-
The static fonts have one file per cut per family. The variable axes have named stops for each of the axes, like `light` or `bold` for weight, `italic` for italics, and `semiwide`and`wide` for width. The combinatoric explosion of all these properties means that the full installation of static fonts involves hundreds of font files. But for situations which don't yet support variable fonts, the static builds give you a wide variety of stops throughout the range of each axis.
23
+
The static fonts have one file per cut, per family. The variable axes have named stops for each axis, like `light` or `bold` for weight, `italic` for italics, and `semiwide`or`wide` for width. The combinatorial explosion of all these properties means the complete installation of static fonts involves hundreds of font files. But for situations that don't yet support variable fonts, the static builds give you a wide variety of stops throughout the range of each axis.
24
24
25
25
## Coding Ligatures
26
26
27
-
There are eight groups of coding ligatures, separated into stylistic sets. You may be able to selectively enable or disable individual sets:
27
+
There are eight groups of coding ligatures, separated into stylistic sets. You may be able to enable or disable individual sets selectively:
28
28
29
29
*`ss01`: ligatures related to the equals glyph like `!=` and `===`.
30
30
*`ss02`: ligatures related to the greater than or less than operators.
@@ -35,73 +35,93 @@ There are eight groups of coding ligatures, separated into stylistic sets. You m
35
35
*`ss07`: ligatures related to the asterisk like `***`.
36
36
*`ss08`: ligatures related to combinations like `.=` or `.-`.
37
37
38
-
You must enable discrectionary ligatures first, often using the `dlig` setting. See below for editor-specific instructions.
38
+
You must enable discretionary ligatures first, often using the `dlig` setting. See below for editor-specific instructions.
39
39
40
40

41
41
42
42
43
43
## Desktop Installation
44
44
45
45
### MacOS
46
-
You can manually drag the fonts from the `fonts/otf`and`fonts/variable` directory into Font Book.
46
+
You can manually drag the fonts from the `fonts/otf`or`fonts/variable` directory into Font Book.
47
47
48
-
There is also a script which automates the deletion of all Monaspace fonts from `~/Library/Fonts` and then copies over the latest versions. Invoke it from the root of the repo like:
48
+
There is also a script that automates the deletion of all Monaspace fonts from `~/Library/Fonts` and then copies over the latest versions. Invoke it from the root of the repo like:
49
49
50
50
```bash
51
-
$ bash ./util/install_macos.sh
51
+
$ cd util
52
+
$ bash ./install_macos.sh
52
53
```
54
+
You can also use [homebrew](https://brew.sh/) as an alternative:
55
+
56
+
```bash
57
+
brew tap homebrew/cask-fonts
58
+
brew install font-monaspace
59
+
```
60
+
61
+
### Windows
62
+
You can manually drag the fonts from the `fonts/otf` or `fonts/variable` directory into `C:\Windows\Fonts`. Alternatively, right-click the fonts you want and click Install.
53
63
54
64
### Linux
55
65
You can manually drag the fonts from the `fonts/otf` and `fonts/variable` directory into `~/.local/share/fonts`.
56
66
57
67
There is also a script which automates the deletion of all Monaspace fonts from `~/.local/share/fonts` and then copies over the latest versions. Invoke it from the root of the repo like:
58
68
59
69
```bash
60
-
$ ./util/install_linux.sh
70
+
$ cd util
71
+
$ bash ./install_linux.sh
61
72
```
62
73
63
74
### Webfonts
64
75
65
-
All files with a `.woff` or `.woff2` suffix are intended for use on the web. You do not install them with your operating system, but rather add them to your web development project.
76
+
All files with a `.woff` or `.woff2` suffix are intended for use on the web. You do not install them with your operating system but add them to your web development project.
66
77
67
-
As with the desktop fonts, they are made availabe both as variable and static fonts.
78
+
As with the desktop fonts, they are available in variable and static versions.
68
79
69
80
## Editors
70
81
71
82
### Visual Studio Code
72
83
73
-
Texture healing and coding ligatures are controlled by the same setting. You can enable either, or both.
> Variable fonts are not yet well-supported in VS Code, and it is not yet possible to mix multiple fonts. Stay tuned, we're talking with the VS Code team about it!
92
+
93
+
The same setting controls texture healing and coding ligatures. You can enable either or both.
74
94
75
95
If you only want texture healing and basic coding ligatures, add the following line to your `settings.json`:
76
96
77
-
```
97
+
```json
78
98
"editor.fontLigatures": true,
79
99
```
80
100
81
101
> [!NOTE]
82
-
> This setting is not available from the graphical settings editor, you must create it manually.
102
+
> This setting is unavailable from the graphical settings editor; you must create it manually.
83
103
84
-
If you want more coding ligatures, you must customize that setting to specify all of the sets you want enabled:
104
+
If you want more coding ligatures, you must customize that setting to specify all the sets you wish to enable:
> You must start the setting with `'calt', 'liga', 'dlig'`! The stylistic sets will not have any effect without enabling contextual alternates, ligatures, and discretionary ligatures.
110
+
> You must start the setting with `'calt', 'liga', 'dlig'`! The stylistic sets will only have an effect by enabling contextual alternates, ligatures, and discretionary ligatures.
91
111
92
-
If you want coding ligatures but do _not_ want texture healing, you can elide the `calt` setting:
112
+
If you want coding ligatures but do _not_ want texture healing, you can omit the `calt` setting:
There's no formal contribution guide yet! If you're interested in contributing to the typefaces, you should read the [Texture Healing](https://github.com/githubnext/monaspace/blob/main/docs/Texture%20Healing.md) guide, as it explains how to produce the neccessary alternate glyphs.
120
+
There's no formal contribution guide yet! If you're interested in contributing to the typefaces, you should read the [Texture Healing](https://github.com/githubnext/monaspace/blob/main/docs/Texture%20Healing.md) guide, as it explains how to produce the necessary alternate glyphs.
101
121
102
122
### Renamer utility
103
123
104
-
This is a convenience utility which renames moves the built fonts into the respective directories. You will need [Deno](https://deno.land) installed, and invoke it thus:
124
+
This convenience utility renames and moves the built fonts into their respective directories. You will need [Deno](https://deno.land) installed, and invoke it thus:
@@ -113,11 +133,11 @@ SIL OFL. See [LICENSE](https://github.com/githubnext/monaspace/blob/main/LICENSE
113
133
114
134
## Support
115
135
116
-
Please file issues on this repo. Monaspace is not a supported product; do not reach out to GitHub support with questions as they do not provide support for GitHub Next explorations.
136
+
Please file issues in this repo. Monaspace is not a supported product; do not contact GitHub support with questions, as they do not support GitHub Next explorations.
117
137
118
138
## Contributors
119
139
120
-
Monaspace was made with the goal of improving all code, for all developers. [GitHub Next](https://githubnext.com) set out on this journey in 2022, and we were fortunate to find a type foundry that shares our passion for improving software in [Lettermatic](https://lettermatic.com/). The result is a marriage of form and function that opens the door to new developer experiences, and that would not have been possible without the domain expertise and skill of the lettermatic team, and the time they invested to work with GitHub Next on figuring out how typography ought to work for code.
140
+
Monaspace was made to improve all code for all developers. [GitHub Next](https://githubnext.com) set out on this journey in 2022, and we were fortunate to find a type foundry that shares our passion for improving software in [Lettermatic](https://lettermatic.com/). The result is a marriage of form and function that opens the door to new developer experiences, and that would not have been possible without the domain expertise and skill of the Lettermatic team and the time they invested in working with GitHub Next on figuring out how typography ought to work for code.
0 commit comments