From 3905268c50f63f61e0ec9b7b61cfda40e3f856ef Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Mon, 23 Oct 2023 07:35:50 +0100 Subject: [PATCH] Fix erroneous documentation (#353) This section confused the behavior of the `docs/reference` shortcode and the generic Markdown reference-style link syntax. Signed-off-by: Jack Baldry --- docs/sources/write/shortcodes/index.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/sources/write/shortcodes/index.md b/docs/sources/write/shortcodes/index.md index 44b7d4720..305381bd3 100644 --- a/docs/sources/write/shortcodes/index.md +++ b/docs/sources/write/shortcodes/index.md @@ -466,15 +466,14 @@ For more information about Grafana dashboards, refer to the [Dashboards document ### Other use cases -The `docs/reference` shortcode is also useful when you want to link to the same destination multiple times in one file. -It allows you to specify the link destination once while you use the label multiple times. For example: +Markdown reference-style links are also useful when you want to link to the same destination multiple times in one file. +It allows you to specify the link destination once while you use the label multiple times. +For example: **Reference:** ```markdown -{{%/* docs/reference */%}} -[Grafana website]: "/ -> www.grafana.com" -{{%/* /docs/reference */%}} +[Grafana website]: www.grafana.com ``` **Body text:**