aboutsummaryrefslogtreecommitdiff
path: root/src/resources/themes/riscv-spec.yml
blob: 4aa95351d0e348f364eaa4823c616c966bede4c1 (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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
extends: default
font:
  catalog:
    merge: true
    sans-serif: GEM_FONTS_DIR/mplus1p-regular-fallback.ttf 
 #Petrona
    body:
      normal: Petrona-Light.ttf
      bold: Petrona-Medium.ttf
      italic: Petrona-LightItalic.ttf
      bold_italic: Petrona-MediumItalic.ttf
      header_thin: Petrona-Thin.ttf
  #Montserrat
    headings:
      normal: Montserrat-Regular.ttf
      italic: Montserrat-Italic.ttf
      bold: Montserrat-Medium.ttf
      light: Montserrat-Light.ttf
    code:
      normal: cmunbtl.ttf
      bold: cmunbtl.ttf
      italic: cmunbto.ttf
      bold_italic: cmunbto.ttf
    # M+ 1mn supports ASCII and the circled numbers used for conums
    M+ 1mn:
      normal: mplus-1mn-regular.ttf
      bold: mplus-1mn-bold.ttf
      italic: mplus-1mn-light.ttf
      bold_italic: mplus-1mn-medium.ttf
    M+ 1p Fallback:
      normal: mplus-1p-regular-fallback.ttf
      bold: mplus-1p-regular-fallback.ttf
      italic: mplus-1p-regular-fallback.ttf
      bold_italic: mplus-1p-regular-fallback.ttf
    Droid Fallback:
      normal: droid-sans-fallback.ttf
      italic: droid-sans-fallback.ttf
      bold: droid-sans-fallback.ttf
      bold_italic: droid-sans-fallback.ttf
    # M+ 1p supports Latin, Latin-1 Supplement, Latin Extended, Greek, Cyrillic, Vietnamese, Japanese & an assortment of symbols
    # It also provides arrows for ->, <-, => and <= replacements in case these glyphs are missing from font
  fallbacks:
    - M+ 1p Fallback
    - Droid Fallback
  svg:
    fallback-font-family: M+ 1mn
page:
  background_color: ffffff
  layout: portrait
  margin: [0.5in, 0.67in, 0.67in, 0.67in]
  # margin_inner and margin_outer keys are used for recto/verso print margins when media=prepress
  margin_inner: 0.75in
  margin_outer: 0.59in
  size: A4
base:
  font-family: body
  font_size: 11.5
  line_height_length: 12
  font_style: normal
  font_size_large: round($base_font_size * 1.25)
  font_size_small: round($base_font_size * 0.85)
  font_size_min: $base_font_size * 0.75
  border_radius: 3
  border_width: 0.25
  border_color: EEEEEE
vertical_rhythm: $base_line_height_length
horizontal_rhythm: $base_line_height_length
 # QUESTION should vertical_spacing be block_spacing instead?
vertical_spacing: $vertical_rhythm  
link:
    font_color: 428bca
  # codespan is currently used for inline monospaced in prose and table cells
codespan:  
    font-color: 000000
    #font_family: code
    #font_family: Droid Fallback
    font_family: M+ 1mn
    font_style: normal
    font-size: 11.5
menu_caret_content: " <font size=\"1.15em\"><color rgb=\"000000\">\u203a</color></font> "
heading:
    align: left
    margin_bottom: 0.25in
    margin_top: 0.5in
    min_height_after: auto
    font_color: 000000
    font_family: headings
    font_style: bold
    h1_font_size: floor($base_font_size * 2.8)
    # h2 is used for chapter titles (book doctype only)
    #h2_font_size: floor($base_font_size * 2.0)
    h2-font-size: 11.5
    #h3_font_size: round($base_font_size * 1.7)
    h3-font-size: 11.5
    #h4_font_size: $base_font_size_large
    h4-font-size: 11.5
    #h5_font_size: $base_font_size
    h5-font-size: 11.5
    h6_font_size: $base_font_size_small
title_page:
    align: center 
    logo:
     top: 10%
    title:
     font_family: headings
     font_style: light
     font_size: floor($base_font_size * 2.8)
     top: 55%
     font_color: 3e058e
    subtitle:
     font_family: headings
     font_style: light
     font_size: floor($base_font_size * 1.2)
     margin-top: 25
    authors:
     font_family: headings
     font_color: 3e058e
     font_style: light
     font_size: floor($base_font_size * .8)
    revision:
     margin_top: $base_font_size * 1.25
block:
  margin_top: 0
  margin_bottom: $vertical_rhythm
caption:
  align: left
  font_size: $base_font_size * 0.95
  font_style: italic
  # FIXME perhaps set line_height instead of / in addition to margins?
  margin_inside: $vertical_rhythm / 3
  #margin_inside: $vertical_rhythm / 4
  margin_outside: 0
lead:
  font_size: $base_font_size_large
  line_height: 1.4
abstract:
  font_color: 5c6266
  font_size: $lead_font_size
  line_height: $lead_line_height
  font_style: italic
  first_line_font_style: bold
  title:
    align: left
    font_color: $heading_font_color
    font_family: $heading_font_family
    font_size: $heading_h4_font_size
    font_style: $heading_font_style
sidebar:
  font-style: italic
  background-color: f5f5fc 
  border-color: 8d81b8
  border-radius: 3
  border-width: 0.2
sidebar-title:
  font_family: $heading_font_family
  font-style: light
  font-color: $heading-font-color
  font-size: 11
  align: left
admonition:
  font-style: italic
  column_rule_color: $base_border_color
  column_rule_width: $base_border_width
  padding: [0, $horizontal_rhythm, 0, $horizontal_rhythm]
  icon:
    note:  
      name: pencil-square-o
      stroke_color: 6489b3
    tip:
      name: comments-o
      stroke_color: 646b74
      size: 24
    important:
      name: info
      stroke_color: 5f8c8b
    warning:
      stroke_color: 9c4d4b
    caution: 
      stroke_color: c99a2c
  label:
    text_transform: uppercase
    font_style: bold
#blockquote:
#  font_color: $base_font_color
#  font_size: $base_font_size_large
#  border_color: $base_border_color
#  border_width: 2
  # FIXME disable negative padding bottom once margin collapsing is implemented
#  padding: [0, $horizontal_rhythm, $block_margin_bottom * -0.75, $horizontal_rhythm + $blockquote_border_width / 2]
#  cite_font_size: $base_font_size_small
#  cite_font_color: 51278d
# code is used for source blocks (perhaps change to source or listing?)
code:
  #font_color: $base_font_color
  font-color: 000000
  font_family: $codespan_font_family
  #font_size: ceil($base_font_size)
  font-size: 11
  padding: $code_font_size
  line_height: 1.15
  # line_gap is an experimental property to control how a background color is applied to an inline block element
  line_gap: 3.8
  #background_color: f4f4fb
  background_color: ffffff
  #border_color: cccccc
  #border_radius: $base_border_radius
  #border_width: 0.2
  caption:
    end: bottom
conum:
  font_family: M+ 1mn
  font_color: $codespan_font_color
  font_size: $base_font_size
  line_height: 4 / 3
example:
  border_color: $base_border_color
  border_radius: $base_border_radius
  border_width: 0.2
  background_color: ffffff
  # FIXME re-enable padding bottom once margin collapsing is implemented
  padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm]
image:
  align: left
  caption:
    align: center
prose:
  margin_top: $block_margin_top
  margin_bottom: $block_margin_bottom
thematic_break:
  border_color: $base_border_color
  border_style: solid
  border_width: $base_border_width
  margin_top: $vertical_rhythm * 0.5
  margin_bottom: $vertical_rhythm * 1.5
description_list:
  term_font_style: bold
  term_spacing: $vertical_rhythm / 4
  description_indent: $horizontal_rhythm * 1.25
list:
  indent: $horizontal_rhythm * 1.5
  #marker_font_color: 404040
  # NOTE outline_list_item_spacing applies to list items that do not have complex content
  item_spacing: $vertical_rhythm / 2
figure:
  caption:
    end: bottom
    align: center
table:
  background_color: $page_background_color
  #head_background_color: #2596be
  #head_font_color: $base_font_color
  head_font_style: bold
  #body_background_color: <hex value>
  body_stripe_background_color: d7d7d7
  foot_background_color: f0f0f0
  border_color: dddddd
  border_width: $base_border_width
  cell_padding: 3
  caption:
    end: top
    align: center 
    text-align: center
    max-width: none
toc:
  indent: $horizontal_rhythm
  line_height: 1.4
  dot-leader:
    content: " "
    font_color: a9a9a9
    font-style: bold
     #levels: 2
  h2-font-style: bold
# NOTE in addition to footer, header is also supported
header:
  font_size: $base_font_size_small
  border_color: dddddd
  border_width: 0.35
  height: $base_line_height_length * 2.6
  line_height: 1
  padding: [$base_line_height_length / 1, 1, .5, 1]
  vertical_align: margin_inside
  recto:
    right: 
      content: '{section-or-chapter-title} | Page {page-number}'
  verso:
    left:
      content: '{section-or-chapter-title} | Page {page-number}'
footer:
  font_size: $base_font_size_small
  border_color: dddddd
  border_width: 0.35
  height: $base_line_height_length * 2.6
  line_height: 1
  padding: [$base_line_height_length / 1, 1, .5, 1]
  vertical_align: top
  #image_vertical_align: <alignment> or <number>
  # additional attributes for content:
  # content: '{company}'
  # * {page-count}
  # * {page-number}
  #center: 
    #content: '{document-title}'
  # * {document-subtitle}
  # * {chapter-title}
  # * {section-title}
  # * {section-or-chapter-title}
  recto:
    #columns: "<50% =0% >50%"
    right:
      #content: '{page-number}'
      content: '{document-title} | © RISC-V'
      #content: '{document-title} | © RISC-V'
      #center: '{page-number}'
      #content: '{revdate}'
  verso:
    #columns: $footer_recto_columns
    left:
      content: $footer_recto_right_content
      #center: '{page-number}'
    #content: '{page-number}'