iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 <HDHALTER@AMAZON.COM>

* Update FORMATTING_GUIDE.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

---------

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Nathan Bower <nbower@amazon.com>
This commit is contained in:
Heather Halter 2023-08-07 11:50:46 -07:00 committed by GitHub
parent c0f7315158
commit aed1d68ae0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
FORMATTING_GUIDE.md
View File

@ -424,6 +424,8 @@ You can style text in the following ways:
* ```**bold**``` * ```**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 ## Variables in curly braces
To correctly display variables that are in curly braces, escape the curly braces with the `{% raw %}{% endraw %}` tags: To correctly display variables that are in curly braces, escape the curly braces with the `{% raw %}{% endraw %}` tags: