Example
When trying to convey a design it often is best to illustrate that with an example. To separate rendered output from the rest of the documentation, you can use the Example shortcode, which semantically and visually encapsulates its contents from the surrounding page.
Definition
| Argument | Type | Notes |
|---|---|---|
| inner | string |
the string passed between opening of closing tags |
| render | boolean |
whether to render the passed content as Markdown or pass through as is; default: false |
| title | string |
sets the component's visible label, rename for translation; default: "Example" |
Usage
Wrap the content you want to mark as an example with the shortcode's tags:
{% example %}
The **content** you want to display
{% endexample %}
The **content** you want to display
Pass true to the shortcode, in order to render the output as Markdown:
The content you want to display