Markdown

The description property of an object is a detailed explanation of the resource. Some description values can use Markdown notation for text formatting.

Markdown provides simple text notation for:

• headings
• paragraphs
• emphasis with italics or bold or both
• numbered or bulleted lists
• hyperlinks

Clients should convert the Markdown notation to properly formatted text when it is displayed. See GitHub Flavored Markdown for specific syntax.

Properties which support Markdown use the JSON schema constraint:

format: markdown