Markdown

1-- Filings due this quarter
2SELECT entity, filing, due_date
3FROM filings
4WHERE due_date < '2027-01-01'
5  AND status = 'not_started'
6ORDER BY due_date;

UsageCopy Anchor Link

import { Markdown } from '@commenda/pathfinder/markdown';

<Markdown content={messagePart.text} isStreaming={status === 'streaming'} />;

Pass each text part without flattening tool calls, attachments, or other message parts into Markdown. The renderer needs no chat provider or AI SDK runtime.

StreamingCopy Anchor Link

Incomplete fences and formatting remain readable while content arrives. Finished blocks use the same components and styles as static content.

ReferencesCopy Anchor Link

Resolve known record URLs using application data. Pathfinder renders the reference and preview; the application supplies routing and data access.

<Markdown
  content={messagePart.text}
  referenceConfig={{
    resolve: (href, label) =>
      href === '/entities/acme'
        ? {
            label,
            href,
            previewConfig: {
              title: 'Acme Pte Ltd',
              content: <EntitySummary entity={entity} />,
            },
          }
        : undefined,
  }}
/>;

Use an icon in the resolved reference to add the correct Pathfinder flag to an entity in a table. The renderer does not infer countries from names.

TablesCopy Anchor Link

Tables use compact Pathfinder cell styles, a pinned first column, horizontal scrolling, copy as TSV, CSV/Markdown downloads, and an expanded dialog. Use Markdown alignment markers (---:) for numeric columns. Rich cell overrides can use existing Pathfinder cells; sorting, editing, and pagination belong in the standalone Table component.

API referenceCopy Anchor Link

Custom renderers are trusted application code and own their accessibility and URL handling. Raw HTML is not a supported extension mechanism. Math, diagrams, custom tool cards, and executable previews are outside Phase 1; their fences render as code.

Design and accessibility rulesCopy Anchor Link

• MARKDOWN-01: Body 13/20; h1/h2 use Heading/15, h3–h6 use Copy/13 Strong. Paragraph gaps 12px; lists 4px between items. No library-default typography.
• MARKDOWN-02: Use this renderer for chat, briefing, and human threads. Keep the application's original message text.
• MARKDOWN-03: Code is inert. Unsafe navigation schemes and executable HTML are not rendered. External links use native browser navigation; app-specific confirmation is an explicit link override.
• MARKDOWN-REF-01: Record references have strong body text and a neutral underline. Preview data belongs to the application.
• MARKDOWN-TABLE-01: Subtle tray, compact semantic table, pinned first column, copy/export/expand controls.
• Streaming marks the content busy but does not announce every token. The conversation layer owns meaningful reply announcements.

Migration notesCopy Anchor Link

// Existing text and stream state can be reused without converting messages.
<Markdown isAnimating={isLiveAssistant && isLastSegment}>
  {segment.part.text}
</Markdown>;

components remains available. Product-specific question fences, math/Mermaid plugins, link-confirmation providers, and word animations are not silently copied; document those separately before migrating a consumer. See the AI content integration guide.