Documenting another (potential) callout issue (#4604)
* Documenting another (potential) callout issue * Deleting ` that was hiding other rendering * Fixing spacing
This commit is contained in:
@@ -144,10 +144,8 @@ Callouts help create different rhetorical appeal levels. Our documentation suppo
|
|||||||
|
|
||||||
2. Use the following syntax to apply a style:
|
2. Use the following syntax to apply a style:
|
||||||
|
|
||||||
```console
|
**Note:** The prefix you use is the same text you use in the tag.
|
||||||
**Note:** The prefix you use is the same text you use in the tag.
|
{: .note} <!-- This tag must appear on a new line. -->
|
||||||
{: .note} <!-- This tag must appear on a new line. -->
|
|
||||||
```
|
|
||||||
|
|
||||||
The output is:
|
The output is:
|
||||||
|
|
||||||
@@ -160,10 +158,8 @@ Use {: .note} to highlight a tip or a piece of information that may be helpful t
|
|||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```console
|
**Note:** You can _still_ use Markdown inside these callouts.
|
||||||
**Note:** You can _still_ use Markdown inside these callouts.
|
{: .note}
|
||||||
{: .note}
|
|
||||||
```
|
|
||||||
|
|
||||||
The output is:
|
The output is:
|
||||||
|
|
||||||
@@ -176,10 +172,8 @@ Use {: .caution} to call attention to an important piece of information to avoid
|
|||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```console
|
**Caution:** The callout style only applies to the line directly above the tag.
|
||||||
**Caution:** The callout style only applies to the line directly above the tag.
|
{: .caution}
|
||||||
{: .caution}
|
|
||||||
```
|
|
||||||
|
|
||||||
The output is:
|
The output is:
|
||||||
|
|
||||||
@@ -192,10 +186,8 @@ Use {: .warning} to indicate danger or a piece of information that is crucial to
|
|||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```console
|
**Warning:** Beware.
|
||||||
**Warning:** Beware.
|
{: .warning}
|
||||||
{: .warning}
|
|
||||||
```
|
|
||||||
|
|
||||||
The output is:
|
The output is:
|
||||||
|
|
||||||
@@ -208,21 +200,17 @@ The output is:
|
|||||||
|
|
||||||
Callout tags must be on a new line to apply the style. Github's Preview Changes feature further obfuscates this fact by rendering the tag on the same line, but your code must match the following syntax:
|
Callout tags must be on a new line to apply the style. Github's Preview Changes feature further obfuscates this fact by rendering the tag on the same line, but your code must match the following syntax:
|
||||||
|
|
||||||
```console
|
**Note:** Your text goes here.
|
||||||
**Note:** Your text goes here.
|
{: .note} <!-- This tag must appear on a new line. -->
|
||||||
{: .note} <!-- This tag must appear on a new line. -->
|
|
||||||
```
|
|
||||||
|
|
||||||
### Multiple Lines
|
### Multiple Lines
|
||||||
|
|
||||||
Callouts should generally be single sentences and automatically span multiple lines. However, you can use `<br/>` tags if you need to create multiple lines.
|
Callouts automatically span multiple lines. However, you can use `<br/>` tags if you need to create multiple lines.
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```console
|
**Note:"** This is my note. Use `<br/>` to create multiple lines. <br/> <br/> You can still use _Markdown_ to **format** text!
|
||||||
**Note:"** This is my note. Use `<br/>` to create multiple lines. <br/> <br/> You can still use _Markdown_ to **format** text!
|
{: .note}
|
||||||
{: .note}
|
|
||||||
```
|
|
||||||
|
|
||||||
The output is:
|
The output is:
|
||||||
|
|
||||||
@@ -231,18 +219,43 @@ The output is:
|
|||||||
|
|
||||||
Typing multiple lines does **not** work. The callout style only applies to the line directly above the tag.
|
Typing multiple lines does **not** work. The callout style only applies to the line directly above the tag.
|
||||||
|
|
||||||
```console
|
**Note:** This is my note.
|
||||||
**Note:** This is my note.
|
|
||||||
|
|
||||||
I didn't read the stlye guide.
|
I didn't read the stlye guide.
|
||||||
{: .note}
|
{: .note}
|
||||||
```
|
|
||||||
|
|
||||||
**Note:** This is my note.
|
**Note:** This is my note.
|
||||||
|
|
||||||
I didn't read the stlye guide.
|
I didn't read the stlye guide.
|
||||||
{: .note}
|
{: .note}
|
||||||
|
|
||||||
|
### Ordered Lists
|
||||||
|
|
||||||
|
Callouts will interupt numbered lists unless you indent three spaces before the notice and the tag.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
1. Preheat oven to 350˚F
|
||||||
|
|
||||||
|
1. Prepare the batter, and pour into springform pan.
|
||||||
|
|
||||||
|
**Note:** Grease the pan for best results.
|
||||||
|
{: .note}
|
||||||
|
|
||||||
|
1. Bake for 20-25 minutes or until set.
|
||||||
|
|
||||||
|
The output is:
|
||||||
|
|
||||||
|
1. Preheat oven to 350˚F
|
||||||
|
|
||||||
|
1. Prepare the batter, and pour into springform pan.
|
||||||
|
|
||||||
|
**Note:** Grease the pan for best results.
|
||||||
|
{: .note}
|
||||||
|
|
||||||
|
1. Bake for 20-25 minutes or until set.
|
||||||
|
|
||||||
|
|
||||||
## Content best practices
|
## Content best practices
|
||||||
|
|
||||||
This section contains suggested best practices for clear, concise, and consistent content.
|
This section contains suggested best practices for clear, concise, and consistent content.
|
||||||
|
|||||||
Reference in New Issue
Block a user