From 5a780227b0dfbecb15c34988dc5e697d2a72d50f Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Mon, 7 Dec 2020 10:50:44 -0800 Subject: [PATCH] Update documentation-markdown-guide.md (#29659) * Update documentation-markdown-guide.md * Update documentation-markdown-guide.md * Update documentation-markdown-guide.md * Update documentation-markdown-guide.md --- .../documentation-markdown-guide.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/contribute/style-guides/documentation-markdown-guide.md b/contribute/style-guides/documentation-markdown-guide.md index 070481ad817..b773edc3732 100644 --- a/contribute/style-guides/documentation-markdown-guide.md +++ b/contribute/style-guides/documentation-markdown-guide.md @@ -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: +``` +Example image +``` + +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: