components/markdown

Import

Import

import * as api from "@fungi.computer/caps/components/markdown";

Exports

Kind	Export	Description
Ttype alias	MarkdownProps	Props accepted by Markdown.
fnfunction	Markdown()	Shared Markdown renderer with safe links, images and highlighted code. Documents use Caps Prose; containing surfaces can supply their own typography and element treatments. Replacing the source renders streaming partial Markdown.

MarkdownPropsTtype alias

Signature

type MarkdownProps = object;

Props accepted by Markdown.

Properties

children

Signature

children: string;

The Markdown source, including an unfinished streaming response.

className?

Signature

optional className?: string;

Extra classes merged onto the rendered container.

components?

Signature

optional components?: MarkdownComponents;

Element treatments; links use the shared policy, images are filtered first.

frontmatter?

Signature

optional frontmatter?: boolean;

Strip a leading YAML frontmatter block before rendering. Defaults to true.

policy?

Signature

optional policy?: "default" | "visitor";

Visitor content allows only absolute HTTP(S) links and never loads images.

typography?

Signature

optional typography?: "prose" | "inherit";

Use Caps Prose, or inherit typography from the containing surface.

Markdown()fnfunction

Signature

function Markdown(__namedParameters): ReactNode;

Shared Markdown renderer with safe links, images and highlighted code. Documents use Caps Prose; containing surfaces can supply their own typography and element treatments. Replacing the source renders streaming partial Markdown.

Parameters

Parameter	Type
__namedParameters	MarkdownProps

Returns

ReactNode