Skip to content

Commit

Permalink
Fix heading param example
Browse files Browse the repository at this point in the history
Signed-off-by: Jack Baldry <[email protected]>
  • Loading branch information
jdbaldry committed Jan 2, 2025
1 parent 927b77f commit c9571ae
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/sources/write/shortcodes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -944,11 +944,12 @@ To add a new variable definition:
1. Define a [`cascade` variable](https://grafana.com/docs/writers-toolkit/write/front-matter/#cascade) in the parent topic.
1. Insert the `param` variable where it's required in the parent and child topics.
{{< admonition type="note" >}}
If you use the `param` shortcode in headings, you must use `%` in place of `<` and `>`.
For example:
For example: `{{% param VARIABLE %}}`.
{{< /admonition >}}
```markdown
# Heading {{%/* param VARIABLE */%}}
```
### Example
Expand Down

0 comments on commit c9571ae

Please sign in to comment.