Skip to content

Commit 8c2b028

Browse files
committed
Add and use Atkinson Hyperlegible and Fira Code fonts
These are being added per the discussion at: https://lists.riscv.org/g/sig-documentation/message/343 The Atkinson Hyperlegible font is being used as the default font for the document. Monospace and source code listings are using Fira Code. Both fonts are freely available under a SIL OpenFonts license and those license documents are included. The TTF files are currently used, but SVG, WOFF, and WOFF2 are also added for future use with web based display platforms.
1 parent 07b9904 commit 8c2b028

39 files changed

+8578
-16
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,16 @@ state are as follows:
190190
====
191191
```
192192
193+
# Fonts
194+
195+
The following fonts are included (linked to their source):
196+
197+
* (Atkinson Hyperlegible)[https://www.brailleinstitute.org/freefont] release 2020-0514 distributed under the terms of the (Open Font License)[https://braileinstitute.app.box.com/s/rin3vzegmcy7sil28yfqslz2r5etv5nl] (archived 2024-11-08)
198+
* (Fira Code)[https://github.com/tonsky/FiraCode] release 6.2 distributed under the terms of the (SIL Open Font License 1.1)[https://github.com/tonsky/FiraCode/blob/master/LICENSE] (archived 2024-11-08)
199+
200+
The license files are also included in the fonts directory for reference.
201+
202+
193203
# Additional information
194204
For additional information, see the [docs-dev-guide/example.pdf](https://github.com/riscv/docs-dev-guide/blob/main/example.pdf) or reach out to
195205
help@riscv.org.

fira_code.css

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
@font-face {
2+
font-family: 'Fira Code';
3+
src: url('woff2/FiraCode-Light.woff2') format('woff2'),
4+
url("woff/FiraCode-Light.woff") format("woff");
5+
font-weight: 300;
6+
font-style: normal;
7+
}
8+
9+
@font-face {
10+
font-family: 'Fira Code';
11+
src: url('woff2/FiraCode-Regular.woff2') format('woff2'),
12+
url("woff/FiraCode-Regular.woff") format("woff");
13+
font-weight: 400;
14+
font-style: normal;
15+
}
16+
17+
@font-face {
18+
font-family: 'Fira Code';
19+
src: url('woff2/FiraCode-Medium.woff2') format('woff2'),
20+
url("woff/FiraCode-Medium.woff") format("woff");
21+
font-weight: 500;
22+
font-style: normal;
23+
}
24+
25+
@font-face {
26+
font-family: 'Fira Code';
27+
src: url('woff2/FiraCode-SemiBold.woff2') format('woff2'),
28+
url("woff/FiraCode-SemiBold.woff") format("woff");
29+
font-weight: 600;
30+
font-style: normal;
31+
}
32+
33+
@font-face {
34+
font-family: 'Fira Code';
35+
src: url('woff2/FiraCode-Bold.woff2') format('woff2'),
36+
url("woff/FiraCode-Bold.woff") format("woff");
37+
font-weight: 700;
38+
font-style: normal;
39+
}
40+
41+
@font-face {
42+
font-family: 'Fira Code VF';
43+
src: url('woff2/FiraCode-VF.woff2') format('woff2-variations'),
44+
url('woff/FiraCode-VF.woff') format('woff-variations');
45+
/* font-weight requires a range: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Fonts/Variable_Fonts_Guide#Using_a_variable_font_font-face_changes */
46+
font-weight: 300 700;
47+
font-style: normal;
48+
}

fonts/Atkinson-Hyperlegible-Bold-102.svg

+2,300
Loading
42.7 KB
Binary file not shown.
23.2 KB
Binary file not shown.
16.1 KB
Binary file not shown.

fonts/Atkinson-Hyperlegible-BoldItalic-102.svg

+2,303
Loading
43.6 KB
Binary file not shown.
24.6 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.

fonts/Atkinson-Hyperlegible-Italic-102.svg

+1,912
Loading
42.5 KB
Binary file not shown.
24 KB
Binary file not shown.
17.3 KB
Binary file not shown.

fonts/Atkinson-Hyperlegible-Regular-102.svg

+1,895
Loading
41.6 KB
Binary file not shown.
22.3 KB
Binary file not shown.
15.5 KB
Binary file not shown.

fonts/FiraCode-Bold.ttf

312 KB
Binary file not shown.

fonts/FiraCode-Bold.woff

135 KB
Binary file not shown.

fonts/FiraCode-Bold.woff2

105 KB
Binary file not shown.

fonts/FiraCode-Light.ttf

282 KB
Binary file not shown.

fonts/FiraCode-Light.woff

128 KB
Binary file not shown.

fonts/FiraCode-Light.woff2

101 KB
Binary file not shown.

fonts/FiraCode-Medium.ttf

277 KB
Binary file not shown.

fonts/FiraCode-Medium.woff

128 KB
Binary file not shown.

fonts/FiraCode-Medium.woff2

100 KB
Binary file not shown.

fonts/FiraCode-Regular.ttf

283 KB
Binary file not shown.

fonts/FiraCode-Regular.woff

128 KB
Binary file not shown.

fonts/FiraCode-Regular.woff2

101 KB
Binary file not shown.

fonts/FiraCode-Retina.ttf

279 KB
Binary file not shown.

fonts/FiraCode-SemiBold.ttf

297 KB
Binary file not shown.

fonts/FiraCode-SemiBold.woff

134 KB
Binary file not shown.

fonts/FiraCode-SemiBold.woff2

104 KB
Binary file not shown.

fonts/FiraCode-VF.woff

135 KB
Binary file not shown.

fonts/FiraCode-VF.woff2

110 KB
Binary file not shown.

fonts/LICENSE-FiraCode.txt

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
Copyright (c) 2014, The Fira Code Project Authors (https://github.com/tonsky/FiraCode)
2+
3+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
4+
This license is copied below, and is also available with a FAQ at:
5+
http://scripts.sil.org/OFL
6+
7+
8+
-----------------------------------------------------------
9+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10+
-----------------------------------------------------------
11+
12+
PREAMBLE
13+
The goals of the Open Font License (OFL) are to stimulate worldwide
14+
development of collaborative font projects, to support the font creation
15+
efforts of academic and linguistic communities, and to provide a free and
16+
open framework in which fonts may be shared and improved in partnership
17+
with others.
18+
19+
The OFL allows the licensed fonts to be used, studied, modified and
20+
redistributed freely as long as they are not sold by themselves. The
21+
fonts, including any derivative works, can be bundled, embedded,
22+
redistributed and/or sold with any software provided that any reserved
23+
names are not used by derivative works. The fonts and derivatives,
24+
however, cannot be released under any other type of license. The
25+
requirement for fonts to remain under this license does not apply
26+
to any document created using the fonts or their derivatives.
27+
28+
DEFINITIONS
29+
"Font Software" refers to the set of files released by the Copyright
30+
Holder(s) under this license and clearly marked as such. This may
31+
include source files, build scripts and documentation.
32+
33+
"Reserved Font Name" refers to any names specified as such after the
34+
copyright statement(s).
35+
36+
"Original Version" refers to the collection of Font Software components as
37+
distributed by the Copyright Holder(s).
38+
39+
"Modified Version" refers to any derivative made by adding to, deleting,
40+
or substituting -- in part or in whole -- any of the components of the
41+
Original Version, by changing formats or by porting the Font Software to a
42+
new environment.
43+
44+
"Author" refers to any designer, engineer, programmer, technical
45+
writer or other person who contributed to the Font Software.
46+
47+
PERMISSION & CONDITIONS
48+
Permission is hereby granted, free of charge, to any person obtaining
49+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
50+
redistribute, and sell modified and unmodified copies of the Font
51+
Software, subject to the following conditions:
52+
53+
1) Neither the Font Software nor any of its individual components,
54+
in Original or Modified Versions, may be sold by itself.
55+
56+
2) Original or Modified Versions of the Font Software may be bundled,
57+
redistributed and/or sold with any software, provided that each copy
58+
contains the above copyright notice and this license. These can be
59+
included either as stand-alone text files, human-readable headers or
60+
in the appropriate machine-readable metadata fields within text or
61+
binary files as long as those fields can be easily viewed by the user.
62+
63+
3) No Modified Version of the Font Software may use the Reserved Font
64+
Name(s) unless explicit written permission is granted by the corresponding
65+
Copyright Holder. This restriction only applies to the primary font name as
66+
presented to the users.
67+
68+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69+
Software shall not be used to promote, endorse or advertise any
70+
Modified Version, except to acknowledge the contribution(s) of the
71+
Copyright Holder(s) and the Author(s) or with their explicit written
72+
permission.
73+
74+
5) The Font Software, modified or unmodified, in part or in whole,
75+
must be distributed entirely under this license, and must not be
76+
distributed under any other license. The requirement for fonts to
77+
remain under this license does not apply to any document created
78+
using the Font Software.
79+
80+
TERMINATION
81+
This license becomes null and void if any of the above conditions are
82+
not met.
83+
84+
DISCLAIMER
85+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93+
OTHER DEALINGS IN THE FONT SOFTWARE.

themes/riscv-pdf.yml

+17-16
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,26 @@ extends: default
33
font:
44
catalog:
55
merge: true
6-
sans-serif: GEM_FONTS_DIR/mplus1p-regular-fallback.ttf
7-
#Petrona
6+
sans-serif: Atkinson-Hyperlegible-Regular-102.ttf
7+
#Atkinson Hyperlegible
88
body:
9-
normal: Petrona-Light.ttf
10-
bold: Petrona-Medium.ttf
11-
italic: Petrona-LightItalic.ttf
12-
bold_italic: Petrona-MediumItalic.ttf
13-
header_thin: Petrona-Thin.ttf
14-
#Montserrat
9+
normal: Atkinson-Hyperlegible-Regular-102.ttf
10+
bold: Atkinson-Hyperlegible-Bold-102.ttf
11+
italic: Atkinson-Hyperlegible-Italic-102.ttf
12+
bold_italic: Atkinson-Hyperlegible-BoldItalic-102.ttf
13+
header_thin: Atkinson-Hyperlegible-Regular-102.ttf
1514
headings:
16-
normal: Montserrat-Regular.ttf
17-
italic: Montserrat-Italic.ttf
18-
bold: Montserrat-Medium.ttf
19-
light: Montserrat-Light.ttf
15+
normal: Atkinson-Hyperlegible-Regular-102.ttf
16+
bold: Atkinson-Hyperlegible-Bold-102.ttf
17+
italic: Atkinson-Hyperlegible-Italic-102.ttf
18+
bold_italic: Atkinson-Hyperlegible-BoldItalic-102.ttf
19+
light: Atkinson-Hyperlegible-Regular-102.ttf
20+
# Fira Code
2021
code:
21-
normal: cmunbtl.ttf
22-
bold: cmunbtl.ttf
23-
italic: cmunbto.ttf
24-
bold_italic: cmunbto.ttf
22+
normal: FiraCode-Regular.ttf
23+
bold: FiraCode-Bold.ttf
24+
italic: FiraCode-Medium.ttf
25+
bold_italic: FiraCode-SemiBold.ttf
2526
# M+ 1mn supports ASCII and the circled numbers used for conums
2627
M+ 1mn:
2728
normal: mplus-1mn-regular.ttf

0 commit comments

Comments
 (0)