Documentation Guides

Definition lists #

Definition lists can be used for things like glossary entries. The term is listed on a line by itself, followed by one or more definitions. Each definition must be begin with a :.

Example of definition-lists #

term A
This is a definition of term A. Text can span multiple lines.
term B
This is a definition of term B.
This has more than one definition.

Representation in Markdown #

term A
: This is a definition of term A. Text
  can span multiple lines.

term B
: This is a definition of term B.
: This has more than one definition.

Breaking changes with mdbook #