Skip to content

Markdown card

The Markdown card adds instructions, links, tables, and other formatted text to a dashboard.

When to use it

Use this card for dashboard-specific guidance, operational notes, links, or small summaries that do not need a table or chart component. Inline text can interpolate values from the dashboard context, so the same message can reflect the current scope and data.

Live example

The Card Lab mounts the production Markdown card and guided configuration form, and lets you edit its configuration and static mock data without a Neops backend. The mock data exposes client, device, group, and interface collections; interpolation can address their singular and plural dashboard-context forms.

Open the Markdown Card Lab in a new page

Requirements

Requirement Value
Dashboard types Standard and aggregation
Minimum size 2 columns by 2 rows
Data None for fixed text. Dashboard context is available to inline interpolation.
Backend capabilities None for inline text. A configured file URL must be reachable by the browser.
Permissions No permission beyond access to the dashboard and any remote file URL.

Configuration

The paths below are relative to cardConfig.data.

text

Property Value
Type string
Required No
Default No saved default. Missing or empty text renders a prompt to provide content when file is not set.
Values Markdown text. {{ expression }} tokens contain JMESPath expressions.

Provides Markdown directly in the dashboard configuration. The card renders headings, emphasis, lists, links, and tables, then applies Carbon styling to lists and tables.

Interpolation evaluates each {{ expression }} token against the dashboard context. An optional fallback can follow !!, for example {{ devices[0].name !! Unknown device }}. Objects and arrays are inserted as JSON text.

file

Property Value
Type string URL or path
Required No
Default No default
Values A URL or browser-resolvable path to a Markdown file

Loads Markdown from a file in the browser instead of using inline text. If file is present, file mode takes precedence even when text is also present. The remote server must allow the browser request, including any required CORS and authentication behavior.

File content does not pass through dashboard-context interpolation.

Examples

Dashboard guidance

{
  "cardId": "markdown",
  "data": {
    "text": "## Maintenance window\n\nValidate interface health before making changes."
  }
}

This configuration renders a heading and a short instruction without requiring backend data.

Context-aware summary

{
  "cardId": "markdown",
  "data": {
    "text": "**Devices in context:** {{ length(devices) !! 0 }}"
  }
}

This configuration updates the displayed count when the dashboard context changes.

Behavior

Inline interpolation refreshes when the dashboard context reports a change and is rate-limited to avoid excessive rendering during bursts of updates. Relative Markdown links are resolved from the current dashboard route while preserving ordinary query parameters and removing dashboard-local filter parameters. Absolute links are preserved.

The card scrolls vertically when its content is taller than the available grid area. An empty inline configuration displays the component’s content prompt.

Limitations and safety

Remote Markdown makes the dashboard depend on the availability, access policy, and trustworthiness of another resource. Only use content controlled by a trusted operator. The backendless Card Lab intentionally blocks file to prevent an editable documentation example from making arbitrary external requests.

Use the Status card when the dashboard needs to classify and count entity data rather than explain it as text.