> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Markdown Widget

> Add rich text documentation, instructions, and notes to dashboards

<Frame>
  <img src="https://mintcdn.com/scalegp/3SJ3nurBJCdCWISt/images/v5/evaluation-dashboards/widget-types/markdown/markdown-base-result.png?fit=max&auto=format&n=3SJ3nurBJCdCWISt&q=85&s=5c56cc7a3152f4082f1615d55a5b5e57" alt="Markdown Widget Example" width="2448" height="528" data-path="images/v5/evaluation-dashboards/widget-types/markdown/markdown-base-result.png" />
</Frame>

## 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

<ParamField body="title" type="string" required>
  Widget title for reference (not displayed in rendered output)
</ParamField>

<ParamField body="type" type="string" required>
  Must be set to "markdown"
</ParamField>

<ParamField body="config.content" type="string" required>
  Markdown-formatted text to display
</ParamField>

### 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

<Steps>
  <Step title="Open Widget Creator">
    From your dashboard, click "Add Widget" and select "Markdown"
  </Step>

  <Step title="Enter Title">
    Give your widget a reference name (e.g., "Dashboard Overview")
  </Step>

  <Step title="Write Content">
    <Frame>
      <img src="https://mintcdn.com/scalegp/3SJ3nurBJCdCWISt/images/v5/evaluation-dashboards/widget-types/markdown/markdown-base-form.png?fit=max&auto=format&n=3SJ3nurBJCdCWISt&q=85&s=3968526076348283c5852a9d14433439" alt="Markdown Editor" width="2490" height="1876" data-path="images/v5/evaluation-dashboards/widget-types/markdown/markdown-base-form.png" />
    </Frame>

    Write or paste your markdown content in the editor. Most editors provide:
  </Step>

  <Step title="Preview">
    <Frame>
      <img src="https://mintcdn.com/scalegp/3SJ3nurBJCdCWISt/images/v5/evaluation-dashboards/widget-types/markdown/markdown-base-form-preview.png?fit=max&auto=format&n=3SJ3nurBJCdCWISt&q=85&s=c2f1ecd25230cde6e6c35de4958c091a" alt="Markdown Preview" width="2490" height="1876" data-path="images/v5/evaluation-dashboards/widget-types/markdown/markdown-base-form-preview.png" />
    </Frame>

    Check the rendered output to ensure formatting looks correct
  </Step>

  <Step title="Create Widget">
    Click "Add" to add to your dashboard

    <Frame>
      <img src="https://mintcdn.com/scalegp/3SJ3nurBJCdCWISt/images/v5/evaluation-dashboards/widget-types/markdown/markdown-base-result.png?fit=max&auto=format&n=3SJ3nurBJCdCWISt&q=85&s=5c56cc7a3152f4082f1615d55a5b5e57" alt="Created Markdown Widget" width="2448" height="528" data-path="images/v5/evaluation-dashboards/widget-types/markdown/markdown-base-result.png" />
    </Frame>
  </Step>
</Steps>

## Related Documentation

* [Heading Widget](./heading) - For simple section headers
* [All Widget Types](./overview) - Compare widget types
* [Getting Started](../getting-started) - Dashboard creation workflow
* [API Reference](/reference/v5/evaluation-dashboards) - Programmatic markdown widget creation
