Web version displays italicized words as monospace, without italics

Open
#2,002 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
55/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
css
Domain
documentation

Research direction

Locate the #documentation #main p em CSS rule shown in the issue and inspect how it affects em elements in the HTML documentation. Adjust the styling so italicized terms render as italics rather than monospace, then compare the HTML examples with the PDF presentation.

Written by the indexing model from the issue text.

Description

Several jargon terms are marked with italics in the PDF version. For example, staged in section The Three States, or remote in section The Refspec.

In the HTML version though, these terms are <em> elements which are formatted as monospace rather than italics. This is due to the following CSS rule, which overrides UA stylesheets:

#documentation #main p em {
  font-family: Courier,monospace !important;
  font-variant-ligatures: none;
  font-style: normal;
  font-weight: 700;
  color: #4e443c;
}

In several cases (jargon terms), it might be sensible to use monospace, but "disabling" italics seems misguided, making the format both less common and harder to distinguish from code fragments. For sure, the format would better be consistent regardless of the version.

Dominant language
CSS
Stars
6.6k
Forks
2.1k
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from progit/progit2

All issues in progit/progit2

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.