View on GitHub

madr

Markdown Architectural Decision Records

Use asterisk as list marker

Context and Problem Statement

Lists in markdown can be indicated by * (asterisk) or - (hypen).

Considered Options

Decision Outcome

Chosen option: “Use an asterisk”, because an asterisk does not have a meaning of “good” or “bad”, whereas a hypen - could be read as indicator of something negative (in contrast to +, which could be more be read as “good”).

According to the Markdown Style Guide, an asterisk as list marker is more readble (see readability profile).