How to Use the Markdown Widget

How to Use the Markdown Widget

The Markdown widget is new (1.16.2). When you Add a Widget in a custom dashboard, you can find it under Graphics and Design, or in All Widgets.



The Markdown widget lets you enter text and apply presentation styles to it, to help describe your custom dashboard. The widget accepts markdown syntax (e.g., **bold**, `code`, etc.), as well as HTML with CSS, and SVG!
Notes
Use the widget only for text content with presentation styling.



Click the Show Chrome button to toggle the card background and drop shadow (you might have to click a couple of times to turn it off).

Why Use a Markdown Widget

You can use the Markdown widget for many purposes, and in combinations…
  1. Add directions: “To change a parameter…”.
  2. Explain how to interpret a nearby chart: “Taller bars are better.”
  3. Offer helpful information: “The total length of all media is 2 hours.”
  4. To cite data sources and useful references: “Data does not include beta testers.”
  5. A custom legend for a widget that normally doesn’t have one: like a gauge.

Storytelling Cookbook

Here are some examples of how to further use the Markdown widget to help with “storytelling” with your dashboard.

Add a Call-out 

Use your computer’s character map to look-up an arrow character (←, ↑, →, ↓), copy it, and then paste it into a Markdown widget, to “call-out” another widget’s significance.
Notes
If using an uncommon character (e.g., an arrow), then select it from a common font (e.g., Arial).
<span style="font-size: 1.25rem; font-weight: bold; ">Markdown Widget</span><br />
<span style="font-size: 0.875rem; ">This widget calls-out others</span>

← For example, the widget to the left is the new **Actor/Object Table**...

Divide the Dashboard

To describe a group of other nearby widgets, add a Markdown widget with a title, subtitle, and explanation of the hierarchy. To vertically divide the widgets in a dashboard, add a Markdown widget that spans the width of the dashboard, and at the top of the widget, enter a horizontal rule HTML element with a thick and dark style.
<hr style="border: 6px solid gray" />




    • Related Articles

    • Why Use More Than One Store?

      The Veracity Learning LRS features multitenancy architecture, which lets you create more than one store in your account. The number of stores you can create depends on your plan and account tier. For example, the free SaaS-hosted plan supports three ...

    • How Do I Add ‘Storytelling’ to a Dashboard?

      If you only use the out-of-the-box dashboards, or have a custom dashboard with one widget, then you’re all set. But, if you decide to build a custom dashboard (or more) with many widgets, then you must consider the overall design. “Widgets” include ...

    • What are xAPI Extensions and How Do I Use Them in My xAPI Statements?

      Best Practices for xAPI Extensions Activity, Context, and Result Extensions in xAPI Statements Do you need to know when and how to best use Activity, Context or Result Extensions in your xAPI Statements? This is a common challenge and a frequently ...

    • What Types of Charts Can I Make in the LRS?

      In general, you can make charts in a custom dashboard using two methods: using our Chart Builder, or by programming our Veracity Query Language (VQL). Chart Builder Charts The Chart Builder and similar form-based wizards in the Veracity Learning LRS ...

    • How Do I Show Percent of Students?

      In a custom dashboard, you can easily build a bar chart that shows the number of unique students per course. Chart Builder with simulated data offered in the free Veracity Learning LRS. Problem But what if you want to show the number of unique ...