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

The keys in the `cover` category control the front and back cover images.
See xref:covers.adoc[] for examples and more information.

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

|back-image
|xref:covers.adoc[image macro] {vbar} xref:covers.adoc[path] +
(default: _not set_)
|[source]
cover:
  back:
    image: image:solid-cover.pdf[]

|front-image
|xref:covers.adoc[image macro] {vbar} xref:covers.adoc[path] +
(default: _not set_)
|[source]
cover:
  front:
    image: image:cover.pdf[page=2]
|===