Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update FORMATTING_GUIDE.md with link to code samples in style guide #4709

Merged
merged 2 commits into from
Aug 7, 2023
Merged

Update FORMATTING_GUIDE.md with link to code samples in style guide #4709

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52b174c
Update FORMATTING_GUIDE.md
hdhalter Aug 7, 2023
3e0e8a0
Update FORMATTING_GUIDE.md
hdhalter Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions FORMATTING_GUIDE.md
View file
Open in desktop
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.