From fbdbda554278f2a1d392ee612bf62ca49f583b75 Mon Sep 17 00:00:00 2001 From: Rosie Le Faive Date: Mon, 24 Aug 2020 11:09:56 -0300 Subject: [PATCH] Render the example helpful tip properly. (#1586) * Render the example helpful tip properly. * Fix note syntax, again. --- docs/contributing/docs_style_guide.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/contributing/docs_style_guide.md b/docs/contributing/docs_style_guide.md index e810b210b..7e092bd01 100644 --- a/docs/contributing/docs_style_guide.md +++ b/docs/contributing/docs_style_guide.md @@ -10,9 +10,20 @@ - Use `-` instead of `*` for bulleted lists. - Upload images to the 'assets' folder and reference them from there. -- For file name, use underscores between words and prefix all file names with the page name, e.g. context_display_hints.jpg for the image showing how to set display hints in the context menu. -- Use `!!! note "Note title"` at the start of a paragraph to have it rendered as a note like this: +- Use the [Admonition syntax](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) to create notes like this (four-space indent required): + +_Example:_ + +``` +!!! note "Helpful Tip" + I am a helpful tip! +``` + +_Result:_ + +!!! note "Helpful Tip" + I am a helpful tip! -!!! note "Helpful Tip" I am a helpful tip! ## Don'ts