summaryrefslogtreecommitdiff
path: root/docs/modules/theme/pages/example.adoc
blob: 5105665a10e4835a27d7eafb4266868ebfa78812 (plain) (blame)
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
= Example Category Keys
:description: Reference list of the available example block category keys and their value types.
:navtitle: Example
:source-language: yaml

The keys in the `example` category control the arrangement and style of example blocks.

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

|background-color
|xref:color.adoc[Color] +
(default: `'FFFFFF'`)
|[source]
example:
  background-color: #FFFEF7

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

|border-radius
|xref:blocks.adoc#radius[Measurement] +
(default: _not set_)
|[source]
example:
  border-radius: 4

|border-style
|xref:blocks.adoc#border-style[Border style] +
(default: `solid`)
|[source]
example:
  border-style: dashed

|border-width
|xref:blocks.adoc#border-width[Measurement] {vbar} xref:blocks.adoc#border-width[Measurement[\]] +
(default: `0.5`)
|[source]
example:
  border-width: 0.75

|font-color
|xref:color.adoc[Color] +
(default: _inherit_)
|[source]
example:
  font-color: #262626

|font-family
|xref:font-support.adoc[Font family name] +
(default: _inherit_)
|[source]
example:
  font-family: M+ 1p

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

|font-size
|xref:language.adoc#values[Number] +
(default: _inherit_)
|[source]
example:
  font-size: 13

|font-style
|xref:text.adoc#font-style[Font style] +
(default: _inherit_)
|[source]
example:
  font-style: italic

|padding
|xref:blocks.adoc#padding[Measurement] {vbar} xref:blocks.adoc#padding[Measurement[\]] +
(default: `12`)
|[source]
example:
  padding: [5, 10, 5, 10]

|text-transform
|xref:text.adoc#transform[Text transform] +
(default: _inherit_)
|[source]
example:
  text-transform: uppercase
|===