From 28c553bebe61f09b240b29a6a301a47a31a12513 Mon Sep 17 00:00:00 2001 From: "vault-token-factory-spectrocloud[bot]" <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Date: Tue, 16 Jul 2024 16:17:17 +0000 Subject: [PATCH] chore: Update README for admonitions (#3387) (#3389) * chore: Update README for admonitions * chore: Fix wording and heading (cherry picked from commit f87c018f2de7b9990681a5e9e22214f2c31fea04) Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 381cab7632..4b802d0567 100644 --- a/README.md +++ b/README.md @@ -465,7 +465,7 @@ 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 @@ -473,6 +473,12 @@ Some **content** with _Markdown_ `syntax`. ::: +:::info + +Some **content** with _Markdown_ `syntax`. + +::: + :::tip Some **content** with _Markdown_ `syntax`. @@ -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":