From c9571ae650489723fc71cb5ee204a5e2e931294b Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Thu, 2 Jan 2025 11:09:37 +0000 Subject: [PATCH] Fix heading param example Signed-off-by: Jack Baldry --- docs/sources/write/shortcodes/index.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/sources/write/shortcodes/index.md b/docs/sources/write/shortcodes/index.md index b732c856b..8550d4f3a 100644 --- a/docs/sources/write/shortcodes/index.md +++ b/docs/sources/write/shortcodes/index.md @@ -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