Fields - Markdown Support

You can pass Markdown syntax as a field value to get the dynamic formatted text inside the output Document.

You need to add an "!" in front of your field name The final syntax should be: {!fieldName}

{description} - Regular Field that supports only text and newline character
{!description} - Special field that supports Markdown as input

Supported Markdown Elements

We support all basic markdown elements and syntax. Please check one of the Markdown Guides: https://www.markdownguide.org/basic-syntax/

# Markdown Cheatsheet

## Headings
# Heading 1
## Heading 2
### Heading 3

## Emphasis
*italic* or _italic_  
**bold** or __bold__  
***bold italic***  
~~strikethrough~~

## Links & Images
[link text](https://documentero.com)  
![alt text](https://documentero.com/custom/landing4.png)

## Lists
Unordered:
- Item A
- Item B
- Item C

Ordered:
1. First
2. Second

Nested:
- Parent
  - Child

## Tables
| Name  | Age |
|-------|-----|
| Alice |  24 |
| Bob   |  30 |

If you pass link elements they will be added as clickable hyperlinks to your document

[link text](https://documentero.com) 

Images

If you pass image elements with a public url they will be downloaded and added to output document

![alt text](https://documentero.com/custom/landing4.png)

Mermaid Diagrams

You can pass mermaid charts, and diagrams using the syntax below. Read more about mermaid syntax: https://mermaid.js.org/intro/

```mermaid
  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;
```

Hints

  • Font settings for text in Markdowncontent will be inherited from your template's Regular Text Styling Settings. You can change them in your document template styling unless they are explicitly defined with styling properties.

  • HTML tags cannot be used inline with other text or bindings. Use them in a separate paragraph:

Some text {!description} rest of text ====> INCORRECT

{#section}  {!description} {/section} ====> INCORRECT

Some text:
{!description} 
rest of text ====> CORRECT

{#section}
{!description}
{/section} ====> CORRECT

Last updated