Link Syntax

To insert hyperlinks in your documents, use a link tag. Link tag syntax is the same as a simple text tag:

{{ MyLink }}

Links are defined in your JSON data using the link object structure shown below:

{
  "MyLink": {
    "_type": "link",
    "target": "https://example.com",
    "text": "Visit Our Website",
    "tooltip": "Learn more about our services"
  }
}

This will create a link to "https://example.com" with the text "Visit Our Website" and a tooltip that appears when hovering over the link.

Link Example
PropertyTypeDescription
_typestringMust be set to "link"
targetstringRequired. The URL for the link
textstringOptional. Display text for the link. If not provided, the target URL will be used
tooltipstringOptional. Tooltip text that appears when hovering over the link

Examples

Simple Example

{
  "MyLink": {
    "_type": "link",
    "target": "https://example.com"
  }
}

Since text is not provided here, the target URL will be used as the link text. This will create a link with the text "https://example.com"

https://example.com

Custom Text and Tooltip

{
  "MyLink": {
    "_type": "link",
    "target": "https://www.company.com",
    "text": "Visit Our Website",
    "tooltip": "Learn more about our services"
  }
}

The resulting document will look like this:

Visit Our Website