forked from asyncapi/website
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d456662
commit 44b3a82
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
title: Formatting style guide | ||
description: This style guide explains about using correct formats when writing documenation. | ||
weight: | ||
--- | ||
## Documentation formatting | ||
|
||
### Notes and warning blocks | ||
|
||
Notes and warning blocks are used to draw attention to important information. Use the following markdown features when necessary: | ||
|
||
- Use a clear and concise heading to introduce the note or warning. | ||
- Use short paragraphs or bullet points to convey the information. | ||
- Keep the language simple and direct. | ||
- Use an `>` in markdown to indicate the nature of the note or warning. | ||
- Use the following Use the following syntax to apply a style. Currently our documenation supports **Remember** `<Remember>`: | ||
* Surround the text with an opening and closing tag. | ||
* Use the following syntax to apply a style: | ||
` <Remember> | ||
No need to add a prefix (Remember); the tag automatically provides one | ||
</Remember>` | ||
|
||
The output: | ||
|
||
<Remember> | ||
No need to add a prefix (Remember); the tag automatically provides one | ||
</Remember> |