File: base.adoc

package info (click to toggle)
ruby-asciidoctor-pdf 2.3.19-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 15,972 kB
  • sloc: ruby: 44,316; sh: 133; java: 45; makefile: 4
file content (154 lines) | stat: -rw-r--r-- 3,868 bytes parent folder | download
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
= Base Category Keys
:description: Reference list of the available base category keys and their value types. The base category provides generic theme settings.
:source-language: yaml
:navtitle: Base

[#base]
== base

The keys in the `base` category provide generic theme settings and are often referenced throughout the theme file as variables.
You can think of this category as roughly analogous to the `body` selector in CSS.
We recommended that you define this category after the xref:page.adoc[page category] and before all other categories.

TIP: While it's common to define additional keys in this category (e.g., `base-border-radius`) to keep your theme DRY, we recommend using xref:variables.adoc#custom[custom variables] instead.

[cols="3,4,6a"]
|===
|Key |Value Type |Example

|border-color
|xref:color.adoc[Color] +
(default: `'EEEEEE'`)
|[source]
base:
  border-color: #F0FFF0

|border-width
|xref:measurement-units.adoc[Measurement] +
(default: `0.5`)
|[source]
base:
  border-width: 0.6

|font-color
|xref:color.adoc[Color] +
(default: `'000000'`)
|[source]
base:
  font-color: #333333

|font-family
|xref:font-support.adoc[Font family name] +
(default: `Helvetica`)
|[source]
base:
  font-family: Noto Serif

|font-kerning
|`none` {vbar} `normal` +
(default: `normal`)
|[source]
base:
  font-kerning: none

|font-size
|xref:language.adoc#values[Number] +
(default: `12`)
|[source]
base:
  font-size: 10.5

|font-size-min
|xref:language.adoc#values[Number] +
(default: `6`)
|[source]
base:
  font-size-min: $base-font-size * 0.75

|font-style
|xref:text.adoc#font-style[Font style] +
(default: `normal`)
|[source]
base:
  font-style: bold

|hyphens
|Boolean {vbar} Language code +
(default: _not set_)
|[source]
base:
  hyphens: true

|<<height,line-height>>
|xref:language.adoc#values[Number] +
(default: `1.15`)
|[source]
base:
  line-height: >
    $base-line-height-length /
    $base-font-size

|<<height,line-height-length>>
|xref:language.adoc#values[Number] +
(default: _not set_)
|[source]
base:
  line-height-length: 12

|text-align
|xref:text.adoc#text-align[Text alignment] +
(default: `left`)
|[source]
base:
  text-align: center

|text-decoration
|xref:text.adoc#decoration[Text decoration] +
(default: `none`)
|[source]
base:
  text-decoration: underline

|text-decoration-color
|xref:color.adoc[Color] +
(default: `$base-font-color`)
|[source]
base:
  text-decoration-color: #0000FF

|text-decoration-width
|xref:measurement-units.adoc[Measurement] +
(default: `1`)
|[source]
base:
  text-decoration-width: 0.5

|<<transform,text-transform>>
|Implicitly set to `none` on `base`.
|_Can't be set on base_.
|===

[#height]
== line-height and line-height-length

Refer to the xref:text.adoc#line-height[line-height] section to learn how to use the `line-height` key.

The `line-height-length` key is a utility property that's internal to the theme.
It's used as an intermediate property for computing the `base-line-height` from the base font size and the desired line height size.
For instance, if you set `base-line-height-length`, you can use `$base-line-height-length / $base-font-size` to set the value of `base-line-height`.
You don't have to go about it this way in your own theme.

[#text-align]
== text-align

The default text alignment can be set globally using the `text-align` key on the `base` category.
While the base theme applies the value `left`, the default theme applies the value `justify`.
If you don't prefer text justification, you can change this behavior by setting this key to `left`.
It's also possible to set the default text alignment using the `text-align` document attribute.

[#transform]
== text-transform

The `text-transform` key can't be set globally.
Therefore, this key shouldn't be used on the `base` category.
The value of `none` is implicit and is only documented in the table above for completeness.