Skip to content

Commit

Permalink
Update FORMATTING_GUIDE.md with link to code samples in style guide (#…
Browse files Browse the repository at this point in the history
…4709)

* Update FORMATTING_GUIDE.md

Added link to style guide.

Signed-off-by: Heather Halter <[email protected]>

* Update FORMATTING_GUIDE.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
  • Loading branch information
2 people authored and vagimeli committed Dec 20, 2023
1 parent d9939a5 commit d1ad6fb
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions FORMATTING_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,9 @@ Body 1 | List:<br>&ensp;&#x2022; One<br>&ensp;&#x2022; 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

Expand All @@ -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.
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.

0 comments on commit d1ad6fb

Please sign in to comment.