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

The keys in the `index` category control the spacing and number of columns in the autogenerated index section.

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

|column-gap
|xref:measurement-units.adoc[Measurement] +
(default: `$base-font-size`)
|[source]
index:
  column-gap: 12

|columns
|Integer +
(default: `2`)
|[source]
index:
  columns: 2
|===