Skip to content

Commit

Permalink
Fix erroneous documentation
Browse files Browse the repository at this point in the history
This section confused the behavior of the `docs/reference` shortcode and the generic Markdown reference-style link syntax.

Signed-off-by: Jack Baldry <[email protected]>
  • Loading branch information
jdbaldry committed Oct 20, 2023
1 parent a04e013 commit cec99e9
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions docs/sources/write/shortcodes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
Expand Down

0 comments on commit cec99e9

Please sign in to comment.