IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-12-28 01:41:24 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation-markdown-guide.md (#29659)

Browse Source 
* Update documentation-markdown-guide.md

* Update documentation-markdown-guide.md

* Update documentation-markdown-guide.md

* Update documentation-markdown-guide.md
This commit is contained in:
Diana Payton 2020-12-07 10:50:44 -08:00 committed by GitHub
parent 90081be9b8
commit 5a780227b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
contribute/style-guides/documentation-markdown-guide.md
View File

@ -116,12 +116,29 @@ Build a list of points - an unordered or unnumbered list - by using "\-" (hyphen
## Images
_Do not_ use image shortcodes at this time.
Include images in a document using the following syntax:
**Example** \!\[Grafana Logo](/link/to/grafanalogo/logo.png)
```
![Alt text](link to image, starting with /img/docs/ if it is to an internal image)
```
**Examples:**
- \!\[Grafana Logo](/link/to/grafanalogo/logo.png)
- \!\[Example](/img/docs/folder_name/alert_test_rule.png)
This follows the format of "!", alt text wrapped in "[]" and the link URL wrapped in "()".
You can also use HTML such as the following:
```
<img src="example.png"
alt="Example image"
style="float: left; margin-right: 5px;" />
```
In most cases, use the markdown syntax rather than the HTML syntax. Only use the HTML if you need to change the image in ways unsupported by Markdown.
## Comments
You can include comments that will not appear in published markdown using the following syntax: