Skip to content

Commit

Permalink
chore: Update README for admonitions (#3387) (#3389)
Browse files Browse the repository at this point in the history
* chore: Update README for admonitions

* chore: Fix wording and heading

(cherry picked from commit f87c018)

Co-authored-by: Yuliia Horbenko <[email protected]>
  • Loading branch information
1 parent 3fc06ee commit 28c553b
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,14 +465,20 @@ Result
![Result](static/assets/docs/images/hide_copy_button.png)
### Admonitions - Warning / Info / Tip / Danger
### Admonitions - Warning / Info / Tip / Danger / Tech Preview / Further Guidance
:::warning
Some **content** with _Markdown_ `syntax`.
:::
:::info
Some **content** with _Markdown_ `syntax`.
:::
:::tip
Some **content** with _Markdown_ `syntax`.
Expand All @@ -485,10 +491,25 @@ Some **content** with _Markdown_ `syntax`.
:::
:::preview
Some **content** with _Markdown_ `syntax`.
:::
:::further
Some **content** with _Markdown_ `syntax`.
:::
https://docusaurus.io/docs/markdown-features/admonitions
The content must have a new line at the beginning and at the end of the tag.
For guidance on using admonitions, refer to
[Spectro Cloud Internal Style Guide: Admonitions/Callouts](https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Admonitions%2FCallouts).
### Video
To add a video, use the following syntax. Ensure you capitalize the letter "V":
Expand Down

0 comments on commit 28c553b

Please sign in to comment.