Use markdown syntax for guide text styling

Last updated:

Note: This article covers the new Visual Design Studio Guide experience, launched Feb. 18th, 2019. If you were a customer before this date and would like to use the Legacy Designer, you can refer back to the previous version.

Pendo’s Visual Design Studio supports HTML, CSS and JavaScript in a Code Block. This allows users to add additional technical customizations. To style text within your Guide content, some Markdown syntax is supported. Use the WYSIWYG controls and you'll see Markdown syntax automatically applied to your Guide content and the style rendered within your preview.

wysiwyg.gif

This article covers the available Markdown syntax supported within the text block of Pendo Guides.

Available syntax

Bold

**Bold**
 

Italics

Italics syntax supports 2 ways:

*Italics*

OR

_Italics_

 

Underline

++Underline++

 

Strikethrough

~~Strikethrough~~

 

Links

[title](https://www.example.com)

 

Ordered lists

1. First item
2. Second item
3. Third item

 

Unordered lists

- First item
- Second item
- Third item
OR
* First item
* Second item
* Third item

OR

+ First item
+ Second item
+ Third item

 

Individual Colored Text

{color: #000000}colored text{/color}

Escape markdown

At times, you might use special characters in your display text where you don’t intend to use Markdown syntax. To escape Markdown in this scenario, add the \character before the character that is being picked up as Markdown.

Example - If you’re trying to create an email link: [first_lastname.example.com](mailto:first_lastname.example.com)

The _ in the display text might be picked up as Markdown but you can escape this by adding a \ in front of the _ so your link will look like this: [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. To use markdown in mobile guides:

  1. Select a guide to open it in the Visual Design Studio.
  2. In the Edit text building block, turn on the Enable markdown button. 

    enable_markdown.png

 

Was this article helpful?
6 out of 12 found this helpful