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

The keys in the `footnotes` category control the style of the footnotes list at the end of a chapter (`book` doctype) or document (other doctypes).
The styling of the links is controlled by the xref:link.adoc[global link styles].
If the `footnotes-title` attribute is set in the document, its value will be used as the caption of the footnotes list.
As such, it will be styled as a xref:caption.adoc[block caption] and can also be configured independently of other captions.

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

|font-color
|xref:color.adoc[Color] +
(default: `$base-font-color`)
|[source]
footnotes:
  font-color: #CCCCCC

|font-size
|xref:text.adoc#font-size[Font size] +
(default: `9`)
|[source]
footnotes:
  font-size: 8

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

|item-spacing
|xref:measurement-units.adoc[Measurement] +
(default: `3`)
|[source]
footnotes:
  item-spacing: 5

|margin-top
|xref:measurement-units.adoc[Measurement] {vbar} `auto` +
(default: `auto`)
|[source]
footnotes:
  margin-top: 0

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