Skip to content

Commit

Permalink
Merge pull request #52 from riscv/dev/kbroch/admonition-block-edits
Browse files Browse the repository at this point in the history
clean up wording, add link to adoc docs, add examples to see icons
  • Loading branch information
kersten1 authored Sep 10, 2024
2 parents af0b145 + 9b0c4ae commit 89f136f
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions src/blocks_notes_markers.adoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,30 @@
[[blocks_notes_markers]]
=== Admonition blocks

Five kinds of standard admonition blocks are available in AsciiDoc. RISC-V uses these 5 standards with the default icons. Note that the admonition type is not displayed, only the icon.
Five types of standard link:https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/[admonition blocks] are available in AsciiDoc. RISC-V uses these five types with the default icons.

NOTE: The admonition type is not displayed, only the icon.

Note:: Highlight extra information that should stand out from the rest of the text. A "by the way, you should know this" statement.

Caution:: Warns users about a condition or action that can lead to bad outcomes such as personal injury or damage equipment). A "we don’t recommend" statement.
NOTE: example of note type

Caution:: Cautions users about a condition or action that can lead to bad outcomes such as personal injury or damage equipment. A "we don’t recommend" statement.

CAUTION: example of caution type

Warning:: Warns users about a situation that is undesirable. A "Do not do this!" or "You must do this" statement.

WARNING: example of warning type

Important:: Information that a user must have. For example, "After you set your password, you cannot change it."

IMPORTANT: example of important type

Tip:: Used for Non-normative text such as clarification or hints for implementers or to convey design rationale and why other options were discontinued. RISC-V tech team is working on a solution that will allow these admonitions to be turned off.

TIP: example of tip type

As a general rule, follow these guidelines for admonitions:

* Understand that admonitions are interruptions. They should be relevant to the topic, but not necessary. If the reader skips reading it, they can still succeed.
Expand Down

0 comments on commit 89f136f

Please sign in to comment.