Skip to content

Commit 041ef92

Browse files
committed
Add information if font is monospaced
[why] Some patched fonts will for sure look strange in a terminal and there is no warning for users. [how] Add information to fonts.json and that will generate a not in the font's readme. This information can also be displayed on the nerdfonts.com website. [note] Fixes: #1804 Signed-off-by: Fini Jastrow <[email protected]>
1 parent e67391f commit 041ef92

File tree

3 files changed

+102
-2
lines changed

3 files changed

+102
-2
lines changed

bin/scripts/lib/README.md

+17
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,23 @@ The 'font matrix' is derived from it.
1111

1212
`get-font-names-from-json.sh` is a small helper to set the matrix up.
1313

14+
The `fonts.json` is the source of a lot details used on the
15+
https://www.nerdfonts.com site and for some scripts. It needs to be
16+
filled manually for each added font.
17+
* `unpatchedName`: [string] Human readable name used in readme
18+
* `licenseId`: [string] SPDX license identifier
19+
* `RFN`: [bool] Has the font a Reserved Font Name clause
20+
* `version`: [string] The real version inside the font files
21+
* `patchedName`: [string] Human readable name used in readme
22+
* `folderName`: [string] Folder name in `src/unpatched-fonts/`
23+
* `imagePreviewFont`: [string] Font family name that should be used for the preview image
24+
* `imagePreviewFontSource`: [string] File name of the font that is can be used to generate the font that is used for the preview image
25+
* `linkPreviewFont`: [string] Anchor to reach the preview at https://www.programmingfonts.org
26+
* `caskName`: [string] Will be expanded by `font-` and `-nerd-font` and must follow the Homebrew naming rules
27+
* `repoRelease`: [bool] Are the patched fonts committed back into the repo
28+
* `isMonospaced`: [bool] Is the source font monospaced, at least some of them (i.e. suitable for terminals)
29+
* `description`: [string] Mention what makes this font stand out
30+
1431
### Cheat Sheet
1532

1633
The glyphs get their names through the individual (per glyph source) i\_\*.sh files in this directory.

0 commit comments

Comments
 (0)