diff --git a/docs/community/styleguide/formatting.md b/docs/community/styleguide/formatting.md deleted file mode 100644 index 103e028e40a9..000000000000 --- a/docs/community/styleguide/formatting.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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** ``: - * Surround the text with an opening and closing tag. - * Use the following syntax to apply a style: -` -No need to add a prefix (Remember); the tag automatically provides one -` - -The output: - - -No need to add a prefix (Remember); the tag automatically provides one -