Markdown is a lightweight markup language with plain text formatting syntax. Docs supports CommonMark compliant Markdown parsed through the Markdig parsing engine. Docs also supports custom Markdown extensions that provide richer content on the Docs site.
Use markup to create playgrounds that show formatted text in rendered documentation mode and to show Quick Help for your Swift code symbols.
Markup Text
## Blockquotes Markdown is a lightweight markup language with plain-text-formatting syntax, created in 2004 by John Gruber with Aaron Swartz. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. In addition to being supported by moin2, the Markdown markup language is used by issue trackers such as those found in Github and Bitbucket. Markup uses simple Markdown-like character delimiter syntax with custom extensions. There are four types of elements: Single line elements format a line of text such as creating a heading. Multiline elements format multiple lines of text such as creating lists or callouts. Span elements format a span of characters such as adding. Markdown and plaintext are What-I-See-Is-What-I-Type. Every app supports plaintext, and therefore, every app supports Markdown formatting. You can write using Markdown in Microsoft Word or Google Docs, but dedicated WISIWIT apps might be more pleasant to use.
Markup for playgrounds includes page level formatting for headings and other elements, formatting spans of characters, showing inline images, and several other features.
For example, Figure 1-1 shows two screenshots of the same playground. The page on the left-hand side of the figure shows the markup in the source editor view for the playground. The right-hand side of the figure shows the playground in rendered documentation mode.
Markup for Swift symbols is used for Quick Help and for the description shown in symbol completion.
For example, the description in the markup in Figure 1-2 is used for the description in symbol completion shown in Figure 1-3.
Markup Markdown Store Brochure Project
The Quick Help shown in Figure 1-4 is generated from the same markup shown above in Figure 1-2.