Circle V2 API Docs
    Preparing search index...
    • Renders a markdown or HTML string safely using react-markdown.

      Supports GitHub Flavored Markdown (tables, strikethrough, task lists) and raw HTML via rehype-raw. All output is sanitized with rehype-sanitize to prevent XSS — script tags, event handlers, etc. are always stripped.

      Parameters

      Returns Element

      <MarkdownRenderer>{"# Hello\n\nSome **bold** text."}</MarkdownRenderer>
      
      // Raw HTML is also accepted and sanitized
      <MarkdownRenderer>{"<p>Hello from <strong>HTML</strong></p>"}</MarkdownRenderer>
    Index

    Properties

    Properties

    displayName: string