Skip to main content
Markdown Widget Example

When to Use

Use markdown widgets to:
  • Document evaluation methodology
  • Provide context for dashboard viewers
  • Add instructions or guidelines
  • Include links to related resources
  • Create formatted notes and observations
  • Define thresholds and alert criteria
  • Credit data sources and team members

Configuration

Required Fields

title
string
required
Widget title for reference (not displayed in rendered output)
type
string
required
Must be set to “markdown”
config.content
string
required
Markdown-formatted text to display

Supported Markdown Syntax

Markdown widgets support standard CommonMark syntax:
  • Headers: # H1, ## H2, ### H3
  • Bold: **bold text**
  • Italic: *italic text*
  • Lists: Bulleted (- item) and numbered (1. item)
  • Links: [text](url)
  • Code: Inline `code` and fenced code blocks
  • Blockquotes: > quote
  • Horizontal rules: ---
  • Tables: Standard markdown tables

Creating in the UI

1

Open Widget Creator

From your dashboard, click “Add Widget” and select “Markdown”
2

Enter Title

Give your widget a reference name (e.g., “Dashboard Overview”)
3

Write Content

Markdown Editor
Write or paste your markdown content in the editor. Most editors provide:
4

Preview

Markdown Preview
Check the rendered output to ensure formatting looks correct
5

Create Widget

Click “Add” to add to your dashboard
Created Markdown Widget