summaryrefslogtreecommitdiff
path: root/docs/modules/theme/pages/sidebar.adoc
blob: f08dac03bad65f8b587038c271808a90bf557e0c (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
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
= Sidebar Category Keys
:description: Reference list of the available sidebar category keys and their value types.
:navtitle: Sidebar
:source-language: yaml

[#sidebar]
== sidebar

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

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

|background-color
|xref:color.adoc[Color] +
(default: `'EEEEEE'`)
|[source]
sidebar:
  background-color: #121212

|border-color
|xref:blocks.adoc#border-color[Color] +
(default: _not set_)
|[source]
sidebar:
  border-color: #FFFFFF

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

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

|border-width
|xref:blocks.adoc#border-width[Measurement] {vbar} xref:blocks.adoc#border-width[Measurement[\]] +
(default: _not set_)
|[source]
sidebar:
  border-width: 0.5

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

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

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

|font-size
|xref:text.adoc#font-size[Font size] +
(default: _inherit_)
|[source]
sidebar:
  font-size: 13

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

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

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

[#title]
== sidebar-title

The keys in the `sidebar-title` category control the arrangement and style of sidebar block titles.

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

|font-color
|xref:color.adoc[Color] +
(default: _inherit_)
|[source]
sidebar:
  title:
    font-color: #333333

|font-family
|xref:font-support.adoc[Font family name] +
(default: _inherit_)
|[source]
sidebar:
  title:
    font-family: Noto Serif

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

|font-size
|xref:text.adoc#font-size[Font size] +
(default: _inherit_)
|[source]
sidebar:
  title:
    font-size: 13

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

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

|text-transform
|xref:text.adoc#transform[Text transform] +
(default: _inherit_)
|[source]
sidebar:
  title:
    text-transform: smallcaps
|===