From aed1d68ae0d0cdf0b2aab4bf45c287b4555db45e Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Mon, 7 Aug 2023 11:50:46 -0700 Subject: [PATCH] Update FORMATTING_GUIDE.md with link to code samples in style guide (#4709) * Update FORMATTING_GUIDE.md Added link to style guide. Signed-off-by: Heather Halter * Update FORMATTING_GUIDE.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter --------- Signed-off-by: Heather Halter Co-authored-by: Nathan Bower --- FORMATTING_GUIDE.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/FORMATTING_GUIDE.md b/FORMATTING_GUIDE.md index 0dd83714..40536444 100644 --- a/FORMATTING_GUIDE.md +++ b/FORMATTING_GUIDE.md @@ -422,7 +422,9 @@ Body 1 | List:
 • One
 • Two You can style text in the following ways: * ```**bold**``` -* ```_italic_``` or ```*italic*``` +* ```_italic_``` or ```*italic*``` + +For guidance on using code examples and when to use code font, see [Code examples](https://github.com/opensearch-project/documentation-website/blob/main/STYLE_GUIDE.md#code-examples). ## Variables in curly braces @@ -444,4 +446,4 @@ To insert a video, add a YouTube player include similar to the following: {% include youtube-player.html id='_g46WiGPhFs' %} ``` -Note that the `id` variable refers to the YouTube video ID at the end of the URL. For example, the YouTube video at the URL `https://youtu.be/_g46WiGPhFs` has the ID `_g46WiGPhFs`. The ID must be surrounded with single quotation marks. \ No newline at end of file +Note that the `id` variable refers to the YouTube video ID at the end of the URL. For example, the YouTube video at the URL `https://youtu.be/_g46WiGPhFs` has the ID `_g46WiGPhFs`. The ID must be surrounded with single quotation marks.