Skip to content

Markdown

The Markdown model represents formatted text content that can be displayed in dashboards.

Markdown supports CommonMark and GitHub Flavored Markdown. You can also render raw HTML within your markdown.

Example

markdowns:
  - name: welcome-text
    content: |
      # Welcome to Visivo

      This is **formatted** text with support for:
      - Lists
      - **Bold** and *italic* text
      - [Links](https://visivo.io)
    align: center
    justify: start

Then reference it in a dashboard item:

items:
  - width: 1
    markdown: ref(welcome-text)

Alignment Options

Controls how text aligns horizontally within the container:

align: left (default)

[Header     ]
[Paragraph  ]
[List       ]

align: center

[  Header   ]
[ Paragraph ]
[   List    ]

align: right

[     Header]
[  Paragraph]
[      List]

Controls how content blocks are distributed vertically in fixed-height containers:

justify: start (default)

[Header     ]
[Paragraph  ]
[List       ]
[           ]
[           ]

justify: center

[           ]
[Header     ]
[Paragraph  ]
[List       ]
[           ]

justify: between

[Header     ]
[           ]
[Paragraph  ]
[           ]
[List       ]

justify: around

[           ]
[Header     ]
[           ]
[Paragraph  ]
[           ]
[List       ]
[           ]

justify: evenly

[           ]
[Header     ]
[Paragraph  ]
[List       ]
[           ]

justify: end

[           ]
[           ]
[Header     ]
[Paragraph  ]
[List       ]

Attributes

Field Type Default Description
path string None A unique path to this object
name string None The unique name of the object across the entire project.
file_path string None The path to the file that contains the object definition.
content string None The markdown text content to display. Supports CommonMark and GitHub Flavored Markdown.
align string left Horizontal alignment of the markdown content. Options are 'left', 'center', or 'right'.
justify string start Vertical distribution of content within its container. Options are 'start', 'end', 'center', 'between', 'around', or 'evenly'.