To style text within your text guide content, some Markdown syntax is supported. Any changes you make to your text using the toolbar above the text that you're editing in the Edit Text window automatically:
- Applies the corresponding Markdown syntax to the text in the Edit Text window.
- Updates the style of the text rendered within your guide preview.
Available syntax
| Syntax | Examples | Rendered utput | |
| Bold | Double asterisks (**) on either side of the text. | **Bold** | Bold |
| Italics |
A single underscore (_) or a single asterisk (*) on either side of the text. |
_Italics_ |
Italics |
|
*Italics* |
|||
| Underline | Double plus sign (++) on either side of the text. | ++Underline++ | Underline |
| Strikethrough | Double tilde (~~) on either side of the text. | ~~Strikethrough~~ | |
| Linked text | Enclose the link title in square brackets ([]) followed by the URL in parentheses (()). | [Pendo](https://app.pendo.io) | Pendo |
|
Unordered list (bullet points) |
For each list item, a dash (-), plus sign (+), or asterisk (*) followed by a space and then text. |
- First item - Second item - Third item |
|
|
+ First item + Second item + Third item |
|||
|
* First item * Second item * Third item |
|||
| Ordered (numbered) list | Start the list with the number one followed by a period (1.) and then a space before adding text for the list item. The numbers don't have to be chronological |
1. First item 2. Second item 3. Third item |
|
|
1. First item 1. Second item 1. Third item |
|||
| Colored text | HTML for adding color to text. |
Add {color: #ec2059}colored text{/color} |
Add colored text |
Escape Markdown
At times, you might use special characters in your text that you don’t intend to use for Markdown syntax. To escape Markdown in this scenario, add the backslash (\) character before the character that's being picked up as Markdown.
For example, if you're trying to create an email like the following, the underscore (_) might be unintentionally recognized as Markdown syntax: [first_lastname.example.com](mailto:first_lastname.example.com)
You can escape this by adding a backslash (\) in front of the underscore (_): [first\_lastname.example.com](mailto:first_lastname.example.com)
Use markdown in mobile guides
Markdown for mobile is supported from SDK version 3.4.0 onwards. To use markdown in mobile guides:
- Open and mobile guide in the Visual Design Studio
- In the Edit text building block, turn on Enable markdown.