Skip to content

Commit 9d350ba

Browse files
Clarify what kind of markdown is allowed (#1203) (#1408)
(cherry picked from commit b429117) Co-authored-by: Charlotte Wickham <[email protected]>
1 parent a0add88 commit 9d350ba

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/authoring/variables.qmd

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The `{{{< meta >}}}` syntax used here is an example of a [shortcode](/docs/exten
2424

2525
If you are using a Quarto project, the `var` shortcode enables you to insert content from a project-level `_variables.yml` file. Create this file alongside your `_quarto.yml` project file, and then include references to those variables within any document in your project.
2626

27-
Variables can be either simple values or can include arbitrary markdown content. To define variables, create a `_variables.yml` file in the root directory of your project. For example:
27+
Variables can be either simple values or markdown content. To define variables, create a `_variables.yml` file in the root directory of your project. For example:
2828

2929
``` yaml
3030
version: 1.2
@@ -38,7 +38,8 @@ engine:
3838
knitr: "[Knitr](<https://yihui.name/knitr>)"
3939
```
4040
41-
Note that the `engine` variable values include markdown for hyperlinks.
41+
Note that the `engine` variable values include markdown for hyperlinks.
42+
Any markdown provided needs to be well-formed, and cannot change the structure of the content around it (e.g. by closing a div opened before the variable inclusion).
4243

4344
To include the value of a variable, use the `{{</* var */>}}` shortcode, for example:
4445

0 commit comments

Comments
 (0)