Skip to content

Markdown Widget

As part of our Custom Dashboard capabilities, Coralogix offers a Markdown Widget. Add tables, lists, reference guides, links, code snippets, images, and more to customize, contextualize, and optimize your dashboards using Markdown syntax.

Overview

Markdown is a lightweight markup language that allows users to format and structure plain text documents using a simple and intuitive syntax. By adding the Markdown Widget to your custom dashboards, you can easily add personalized context to your dashboards using straightforward symbols and conventions.

  • Bookmark Coralogix features to drill deeper and find more insights.

  • Add tables, lists, reference guides, links, code-snippets, images and more.

  • Explain complicated syntax queries.

No prior knowledge of Markdown is required. You have the option to edit in Markdown or take advantage of the simplified WYSIWYG editor that converts your input to Markdown.

Create a Markdown Widget

1

In a custom dashboard, drag and drop the Markdown Widget from your left-hand side bar to get started.

2

Enter your Markdown content in the Markdown Widget.

The widget has two sections. The lower section allows you to edit in Markdown and contains a simplified WYSIWYG editor that is converted to Markdown.

The WYSIWYG editor includes the following options for editing Markdown:

  • Bold
  • Italics
  • Strikethrough
  • Heading/Normal text
  • Bulleted list
  • Numbered list
  • Checkbox list
  • Add Link
  • Quote
  • Code
  • Code Block
  • Add table
  • Add divider
3

[Optional] Add any text to the tooltip to be shown when you hover over the widget title bar.

4

[Optional] If you want to save your dashboard with the new widget, click SAVE in the upper right hand corner.

Share widget URL

Share a direct link to a specific widget the same dashboard URL, focused on the widget you shared.

You can share a widget in two ways:

  • In the widget’s more actions menu, select Share widget URL to copy a link to your clipboard that includes the widget’s widgetId in the URL parameter.
  • Focus the widget to update the browser URL with its widgetId parameter, then copy the URL directly from the address bar.

Anyone with access to the dashboard can open the shared link to view the widget in context.

Note

Shared widget URLs reflect the dashboard’s last saved version.
If you’ve made changes to the widget or layout, save your dashboard before sharing.

Share section URL

Share a direct link to a section. The shared link also uses the section's widgetId parameter in the URL. The link opens the same dashboard, navigates directly to the section, and expands it by default—even if it was saved as collapsed.

To share a section:

In the section’s more actions menu, select Share section URL to copy a link to your clipboard that includes the section’s widgetId.

Anyone with access to the dashboard can open the shared URL to jump directly to that section.

Note

Shared section URLs reflect the dashboard’s last saved version. Save your dashboard before sharing to avoid sharing outdated layout states.

Additional Resources

DocumentationCustom Dashboards
Line Charts
Data Tables
Gauges
Pie Charts
Vertical Bar Charts
Horizontal Bar Charts

Support

Need help?

Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.

Feel free to reach out to us via our in-app chat or by sending us an email at support@coralogix.com.

Was this helpful?