aboutsummaryrefslogtreecommitdiff
path: root/style.md
blob: bbddddf627414a96acaa3752d4fea2ad4479c85a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Fonts

The documents use the following fonts. All of these are free and open source,
and are likely available from your system's package manager if you are using
Linux.

If the documents fail to compile after installing these fonts, please check if
you are using a LaTeX compiler with support for the `fontspec` package (i.e.
`xelatex` or `lualatex`). The included `latexmkrc` file \*should\* cover LaTeX
workshop and VimTeX.

|Family|Usage|Typeface|
|-|-|-|
|serif|Body text (default)|[TeX Gyre Schola][texgyreschola]|
|math|Math|[TeX Gyre Schola Math][texgyreschola-math]|
|sans-serif|Figures|[Inter][inter]|
|monospace|URLs, code listings|[JetBrains Mono][jetbrains-mono]|

[inter]: https://rsms.me/inter
[texgyreschola]: https://www.gust.org.pl/projects/e-foundry/tex-gyre/schola/index_html
[texgyreschola-math]: https://www.gust.org.pl/projects/e-foundry/tg-math/download/index_html#Schola_Math
[jetbrains-mono]: https://www.jetbrains.com/lp/mono

# Spelling

All documentation is written in U.S. English

# Grammar

## Comma And

**In lists**, the last element is mentioned using the word 'and', *without* a
comma.

**When joining independent clauses**, keep a comma before the word 'and'.
Usually, this comma can be left out for short clauses, but we keep them in for
consistency.

**Good examples:**

> The first, second and last items.
>
> Action X was performed, and this had Y impact.

# Figures

Non-raster figures are preferred over rasterized figures (where applicable).
Please note that LaTeX does not support SVG images, and these need to be
converted to PDF (e.g. using `svg2pdf` on linux).

Raster images should only be used when the source is already in a raster format
(e.g. for photos) or when otherwise impractical.