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

[#prose]
== prose

The keys in the `prose` category control the spacing below paragraphs, lists, and index categories.
The bottom margin is only added if the block is followed by an adjacent block within the same enclosure (e.g., a sidebar, a table cell, or the area outside a block).

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

|margin-bottom
|xref:measurement-units.adoc[Measurement] +
(default: `12`)
|[source]
prose:
  margin-bottom: 6

|<<margin-inner,margin-inner>>
|xref:measurement-units.adoc[Measurement] +
(default: `$prose-margin-bottom`)
|[source]
prose:
  margin-inner: 0

|text-indent
|xref:measurement-units.adoc[Measurement] +
(default: _not set_)
|[source]
prose:
  text-indent: 18

|<<text-indent-inner,text-indent-inner>>
|xref:measurement-units.adoc[Measurement] +
(default: _not set_)
|[source]
prose:
  text-indent-inner: 18
|===

[#margin-inner]
== margin-inner

The `margin-inner` key controls the margin between adjacent paragraphs.
It's useful when using indented paragraphs.

[#text-indent-inner]
== text-indent-inner

The `text-indent-inner` key is only applied to inner paragraphs.
Inner paragraphs are paragraphs that follow an adjacent paragraph.