Clarify that NOTE, etc., are separate block level elements
Summary: Fixes T6965. Test Plan: Read documentation. Reviewers: btrahan, chad Reviewed By: chad Subscribers: epriestley Maniphest Tasks: T6965 Differential Revision: https://secure.phabricator.com/D11941
This commit is contained in:
@@ -258,18 +258,30 @@ You can use `lines=N` to limit the vertical size of a chunk of code, and
|
|||||||
<p>Mangostine</p>
|
<p>Mangostine</p>
|
||||||
<p>Melon</p>
|
<p>Melon</p>
|
||||||
|
|
||||||
You can also use `NOTE:`, `WARNING:`, or `IMPORTANT:` to call out an important
|
|
||||||
idea.
|
You can use the `NOTE:`, `WARNING:` or `IMPORTANT:` elements to call attention
|
||||||
|
to an important idea.
|
||||||
|
|
||||||
|
For example, write this:
|
||||||
|
|
||||||
|
```
|
||||||
|
NOTE: Best practices in proton pack operation include not crossing the streams.
|
||||||
|
```
|
||||||
|
|
||||||
|
...to produce this:
|
||||||
|
|
||||||
NOTE: Best practices in proton pack operation include not crossing the streams.
|
NOTE: Best practices in proton pack operation include not crossing the streams.
|
||||||
|
|
||||||
|
Using `WARNING:` or `IMPORTANT:` at the beginning of the line changes the
|
||||||
|
color of the callout:
|
||||||
|
|
||||||
WARNING: Crossing the streams can result in total protonic reversal!
|
WARNING: Crossing the streams can result in total protonic reversal!
|
||||||
|
|
||||||
IMPORTANT: Don't cross the streams!
|
IMPORTANT: Don't cross the streams!
|
||||||
|
|
||||||
In addition, you can use `(NOTE)`, `(WARNING)`, or `(IMPORTANT)` to get the
|
In addition, you can use `(NOTE)`, `(WARNING)`, or `(IMPORTANT)` to get the
|
||||||
same effect but without `(NOTE)`, `(WARNING)`, or `(IMPORTANT)` appearing in
|
same effect but without `(NOTE)`, `(WARNING)`, or `(IMPORTANT)` appearing in
|
||||||
the rendered result. For example
|
the rendered result. For example, this callout uses `(NOTE)`:
|
||||||
|
|
||||||
(NOTE) Dr. Egon Spengler is the best resource for additional proton pack
|
(NOTE) Dr. Egon Spengler is the best resource for additional proton pack
|
||||||
questions.
|
questions.
|
||||||
|
|||||||
Reference in New Issue
Block a user