Description List Category Keys

description-list

The keys in the description-list category control the arrangement and style of description list terms and descriptions.

Key Value Type Example

description-indent

Number
(default: 30)

 
description-list:
  description-indent: 15
yaml

term-font-color

Color
(default: inherit)

 
description-list:
  term-font-color: #AA0000
yaml

term-font-family

Font family name
(default: inherit)

 
description-list:
  term-font-family: Noto Serif
yaml

term-font-kerning

none | normal
(default: inherit)

 
description-list:
  term-font-kerning: none
yaml

term-font-size

Number
(default: inherit)

 
description-list:
  term-font-size: 12
yaml

term-font-style

Font style
(default: bold)

 
description-list:
  term-font-style: italic
yaml

term-line-height

Number
(default: $base-line-height)

 
description-list:
  term-line-height: 1.2
yaml

term-spacing

Measurement
(default: 4)

 
description-list:
  term-spacing: 5
yaml

term-text-transform

Text transform
(default: none)

 
description-list:
  term-text-transform: smallcaps
yaml

Ordered and unordered description lists

Asciidoctor PDF supports unordered and ordered description lists. These are defined as a description list, but displayed as an unordered or ordered description list with the term as a subject. Only one term is supported. The subject is shown using the term font style (bold by default).

By default, the subject is arranged as a run-in followed by a subject stop (: by default).

[unordered]
alpha:: partially complete and unstable
beta:: feature complete and undergoing testing
asciidoc

The subject stop can be customized using the subject-stop attribute.

[unordered,subject-stop=)]
alpha:: partially complete and unstable
beta:: feature complete and undergoing testing
asciidoc

If the stack role is present, the subject is stacked above the description. In this case, the subject stop is only used if specified explicitly.

[unordered.stack]
alpha:: partially complete and unstable
beta:: feature complete and undergoing testing
asciidoc