Guides and Sample Code

Developer

Markup Formatting Reference

Markup Overview

Use markup to create playgrounds that show formatted text in rendered documentation mode and to show Quick Help for your Swift code symbols.

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.

Figure 1-1Markup in playgrounds image: ../Art/MFR_playground_eg_2x.png

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.

Figure 1-2Markup for Swift symbols image: ../Art/MFR_symbol_markup_eg_2x.png
Figure 1-3Custom description in code completion image: ../Art/MFR_completion_eg_2x.png

The Quick Help shown in Figure 1-4 is generated from the same markup shown above in Figure 1-2.

Figure 1-4Custom Quick Help image: ../Art/MFR_quickhelp_eg_2x.png