Skip to content

Commit bc67616

Browse files
authored
Display concrete examples of the different types of asides (#1123)
1 parent a9e276f commit bc67616

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

Sources/docc/DocCDocumentation.docc/other-formatting-options.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@ configuration. For those situations, use an aside.
1414

1515
DocC supports the following types of asides:
1616

17-
| Type | Usage |
18-
| ----- | ------ |
19-
| Note | General information that applies to some users. |
20-
| Important | Important information, such as a requirement. |
21-
| Warning | Critical information, like potential data loss or an irrecoverable state. |
22-
| Tip | Helpful information, such as shortcuts, suggestions, or hints. |
23-
| Experiment | Instructional information to reinforce a learning objective, or to encourage developers to try out different parts of your framework. |
17+
> Note: General information that applies to some users.
18+
19+
> Important: Important information, such as a requirement.
20+
21+
> Warning: Critical information, like potential data loss or an irrecoverable state.
22+
23+
> Tip: Helpful information, such as shortcuts, suggestions, or hints.
24+
25+
> Experiment: Instructional information to reinforce a learning objective, or to encourage developers to try out different parts of your framework.
2426
2527
To create an aside, begin a new line with a greater-than symbol (`>`), add a space,
2628
the type of the aside, a colon (`:`), and the content of the aside.

0 commit comments

Comments
 (0)