Skip to main content
Palo Alto Networks Cortex XCOR supports Markdown in several places where you write or exchange formatted text. The supported syntax and editing tools depend on the resource or resource component.

Markdown support by resource and component

The following table summarizes how each resource or component uses Markdown: Markdown panels, comments, and resolution notes support the syntax in the following section. The annotation documentation covers a focused set of inline formatting. Notebooks use a rich text editor and convert content to and from Markdown.

Write Markdown

Use the following syntax in Markdown panels, comments, and resolution notes:
To create a table, use pipe characters (|) to separate columns. Use a row of hyphens to separate the column headings from the table rows:
Raw HTML behavior depends on where you use it. Unsupported elements or attributes might be removed or rendered as literal text. Use Markdown syntax instead of raw HTML.

Format annotations

Annotations support the following Markdown syntax:
  • Bold text: **text**
  • Inline code: `code`
  • Named links: [label](https://example.com)
  • Plain HTTP and HTTPS URLs
Keep the annotation-specific configuration, including template variables, in the monitor or SLO definition. Monitor templates can reference alert values, labels, external labels, and the instance base URL. Alert start and end values expand when notifications are rendered.

Use Markdown with notebooks

Notebooks use a rich text editor instead of a Markdown source editor. Copy a notebook as Markdown to use its content outside Cortex XCOR. To convert pasted Markdown to rich text, include a supported block element, such as a heading, list, block quote, fenced code block, table, horizontal rule, or details block. Content that contains only inline Markdown might paste as literal text. The notebook Markdown format includes standard text formatting, tables, task lists, Mermaid diagrams, and Cortex XCOR visualization panels. Some rich notebook content changes when copied to Markdown and pasted again. For the supported content and conversion behavior, see Use Markdown with notebooks.