From a57c1d845d1d8e92fcb104e0fa39edbf64145e9c Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Tue, 3 Dec 2019 14:09:00 -0400 Subject: [PATCH 1/2] Update docs_style_guide.md --- docs/contributing/docs_style_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/docs_style_guide.md b/docs/contributing/docs_style_guide.md index 029810f49..d9ba9d47a 100644 --- a/docs/contributing/docs_style_guide.md +++ b/docs/contributing/docs_style_guide.md @@ -12,7 +12,7 @@ -- 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` at the start of a paragraph to have it rendered as a note like this: -!!! note I am a helpful tip! +!!! note "Helpful Tip" I am a helpful tip! ## Don'ts From 35717ba52ad80f3d3ab071551d7b3a5dbb52ef88 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Wed, 4 Dec 2019 09:33:57 -0400 Subject: [PATCH 2/2] Update docs_style_guide.md --- docs/contributing/docs_style_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/docs_style_guide.md b/docs/contributing/docs_style_guide.md index d9ba9d47a..e810b210b 100644 --- a/docs/contributing/docs_style_guide.md +++ b/docs/contributing/docs_style_guide.md @@ -10,7 +10,7 @@ - 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` at the start of a paragraph to have it rendered as a note like this: +- Use `!!! note "Note title"` at the start of a paragraph to have it rendered as a note like this: !!! note "Helpful Tip" I am a helpful tip!