Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display concrete examples of the different types of asides #1123

Merged
merged 1 commit into from
Dec 10, 2024
+9 −7
Merged

Display concrete examples of the different types of asides #1123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions Sources/docc/DocCDocumentation.docc/other-formatting-options.md
View file
Open in desktop
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