1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
# Other Formatting Options
Improve the presentation and structure of your content by incorporating special page elements.
## Overview
DocC offers support for various types of elements such as [tables](doc:adding-tables-of-data), notes, and asides.
### Add Notes and Other Asides
There may be circumstances when you want to get the reader's attention to
provide additional advice, or to warn them about common errors or requisite
configuration. For those situations, use an aside.
DocC supports the following types of asides:
| Type | Usage |
| ----- | ------ |
| Note | General information that applies to some users. |
| Important | Important information, such as a requirement. |
| Warning | Critical information, like potential data loss or an irrecoverable state. |
| Tip | Helpful information, such as shortcuts, suggestions, or hints. |
| Experiment | Instructional information to reinforce a learning objective, or to encourage developers to try out different parts of your framework. |
To create an aside, begin a new line with a greater-than symbol (`>`), add a space,
the type of the aside, a colon (`:`), and the content of the aside.
```markdown
> Tip: Sloths require sustenance to perform activities.
```
For the example above, DocC renders the following aside:
> Tip: Sloths require sustenance to perform activities.
The text of an aside can use the same style attributes as other text, and
include links to other content, including symbols. However, asides don't provide support for multiple paragraphs, lists, code blocks, or images.
### Include Special Characters in Text
To escape one or more special characters, precede each with a backslash
(`\`).
For example, to display an asterisk (`*`) at the beginning of a line and prevent
DocC from converting it into a bulleted list item, place a backslash immediately before it.
```
\* Not a bulleted list item.
```
If you use single (`*`) or double (`**`) asterisks to apply italic or bold
styling, respectively, you can escape any asterisks that the text contains so
DocC doesn't prematurely terminate the styling.
```
*Sloths require sustenance\* to perform activities.*
**Sloths require sustenance\*\* to perform activities.**
```
DocC also supports the translation of hex codes and HTML entities. For example, using the hex code `\©`
will render as the copyright sign (©).
<!-- Copyright (c) 2023-2024 Apple Inc and the Swift Project authors. All Rights Reserved. -->
|
