Developer

Appearance

Annotation Markdown Syntax

Complete guide to markdown syntax supported in rooomProducts viewer annotations using parser. Learn formatting, custom tokens, and interactive elements.

Basic Text Formatting ​

Headers ​

Use hash symbols to create headers (1-6 levels):

markdown
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

You can also use underline syntax for H1 and H2:

markdown
Header 1
========

Header 2
--------

Text Styling ​

Format text with emphasis and strong emphasis:

markdown
*Italic text* or _italic text_
**Bold text**
~~Strikethrough text~~

WARNING

Triple emphasis (***bold and italic***) is not supported.

Line Breaks and Paragraphs ​

Create line breaks and paragraphs:

markdown
First line
Second line (two spaces at end for line break)

New paragraph (empty line creates paragraph break)

Lists ​

Unordered Lists ​

Create bullet points using -, *, or +:

markdown
- Item 1
- Item 2
- Item 3

Ordered Lists ​

Create numbered lists:

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

Nested Lists

Complex nested lists may not render correctly. Keep list structures simple for best results.

Create clickable links:

markdown
[Link text](https://example.com)

You can also use reference-style links:

markdown
[Link text][ref]

[ref]: https://example.com

Images ​

Embed images in annotations:

markdown
![Alt text](https://example.com/image.jpg)

Code ​

Inline Code ​

Use backticks for inline code:

markdown
Use the `ProductViewer` API to control annotations.

Code Blocks ​

Create code blocks with optional language specification:

markdown
```javascript
api.createAnnotation([100, 100], {
  title: 'Product Feature',
  description: 'This is a **markdown** description'
});
```

Or simple indented code blocks:

markdown
    // This is also a code block
    const viewer = new ProductViewer(iframe);

Blockquotes ​

Highlight important information using >:

markdown
> This is a blockquote
>
> It can span multiple lines

WARNING

Nested blockquotes may not render correctly.

Horizontal Rules ​

Create visual separators:

markdown
---

Iframe Modal ​

The iframe-modal token creates interactive modal windows with embedded content:

markdown
{iframe-modal:Rooom Website|https://rooom.com}
{iframe-modal:Product Demo|https://demo.rooom.com/product-showcase}

Syntax: {iframe-modal:Display Name|URL}

  • Display Name: The text that appears as a clickable link
  • URL: The website or content to display in the modal

Example Usage:

markdown
Learn more about our technology: {iframe-modal:rooom Platform|https://rooom.com}

View the complete product catalog: {iframe-modal:Product Gallery|https://gallery.rooom.com}

Unsupported Features ​

The following standard Markdown features are not supported:

  • Tables
  • Task lists (checkboxes)
  • Footnotes
  • Definition lists
  • Complex nested lists
  • HTML tags (for security reasons)
  • Math expressions
  • Emoji shortcodes
  • Triple emphasis (***text***)
  • Underline formatting