git / git-scm.com

The git-scm.com website. Note that this repository is only for the website; issues with git itself should go to https://git-scm.com/community.
https://git-scm.com/
MIT License
2.16k stars 1.21k forks source link

Ligatures in monospace fonts hurt legibility of config keys #1817

Closed rybak closed 3 days ago

rybak commented 10 months ago

The choice of the font in app/assets/stylesheets/variables.scss for the rule:

$fixed-width-font-family: Courier, monospace;

can make it harder to read some of the text in the documentation. This is especially applicable to the names of the configuration keys and to mentions of the shell commands, which people would usually edit in a text editor or in a shell with a monospace font. Fonts used by <code> tags are also affected.

URL for broken page

Example: https://git-scm.com/docs/git-config

Problem

Ligatures in the fonts for the Courier in CSS make it harder to read parts of the website.

Operating system and browser

Operating System: KDE neon 5.27 (≈ Kubuntu 22.04)
Browser: Firefox 119.0

Steps to reproduce

  1. Look at mentions of reflog in monospace font on page https://git-scm.com/docs/git-config#Documentation/git-config.txt-gcreflogExpireUnreachable screenshot of mention of gc.reflogExpireUnreachable in Git documentation

Other details

sparr commented 8 months ago

https://github.com/ArtifexSoftware/urw-base35-fonts/issues/31

font-variant-ligatures: none; seems like a good fix, until various monospace fonts stop shipping this sort of ligature