Skip to content

Commit

Permalink
Display concrete examples of the different types of asides (#1123)
Browse files Browse the repository at this point in the history
  • Loading branch information
j-f1 authored Dec 10, 2024
1 parent a9e276f commit bc67616
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions Sources/docc/DocCDocumentation.docc/other-formatting-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,15 @@ 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. |
> 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.
Expand Down

0 comments on commit bc67616

Please sign in to comment.