public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Link to contributing docs and fix some image markdown examples (#39726)

Browse Source
This commit is contained in:
Andrej Ocenas
2021-09-30 18:59:35 +02:00
committed by GitHub
parent 2b4e51f478
commit 14d90b0cf8
2 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
contribute/style-guides/documentation-markdown-guide.md
+3 -3
View File
@@ -121,15 +121,15 @@ _Do not_ use image shortcodes at this time.
Include images in a document using the following syntax:
```
![Alt text](link to image, starting with /img/docs/ if it is to an internal image "Title of image in sentence case")
![Alt text](link to image, starting with /static/img/docs/ if it is to an internal image "Title of image in sentence case")
```
> **Note:** Alt text does not appear when the user hovers the mouse over the image, but title text does.
**Examples:**
- \!\[Grafana logo](/link/to/grafanalogo/logo.png)
- \!\[Example](/img/docs/folder_name/alert_test_rule.png)
- \!\[Grafana logo](/link/to/grafanalogo/logo.png "Grafana logo")
- \!\[Example](/static/img/docs/folder_name/alert_test_rule.png "Example title")
This follows the format of "!", alt text wrapped in "[]" and the link URL wrapped in "()".