Skip to content

Commit

Permalink
call out restrictions on Var in code blocks (#18393)
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Fornuto authored Nov 22, 2022
1 parent 53f9537 commit b85de1a
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/pages/contributing/documentation/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -512,6 +512,14 @@ $ curl https://<Var name="proxy"/>/webapi/ping

</Details>

<Admonition type="tip">

The `Var` component only works in [code blocks](#code-blocks) using the `code`
syntax (e.g. <code>```code</code>), and only for "command" lines (beginning
with `$`). The component will work without caveats outside of code blocks.

</Admonition>

When a user updates the value of an in-page variable, the values of any `Var`
components with the same `name` property update automatically. When you copy a
`code` snippet using the copy button, the values of any in-page variables within
Expand Down

0 comments on commit b85de1a

Please sign in to comment.