Content

Markdown

Gives rendered Markdown Mizen's reading layout and element styling, with any parser.

idle

Usage

import { Markdown } from "@mizen-labs/ui";

Guidance	Practice
Do	Render the document inside Markdown with markdownComponents, for example through react-markdown with remark-gfm and skipHtml.
Do	Give each document an id and pass it as the parser's footnote prefix.

Guidance	Boundary
Scope	Mizen ships no parser. The app owns parsing, plugins, raw HTML policy, and URL sanitizing for untrusted content.
Scope	Footnote labels share one ID across documents on a page; this is a remark-rehype limitation.

Public props from @mizen-labs/ui. Use exported prop types for the complete TypeScript contract.

Prop	Type	Default	Description
`Markdown.children`	`ReactNode`	`Required`	The rendered document, usually a react-markdown or MDX tree that uses markdownComponents.
`Markdown.id`	`string`	`None`	Anchors the document; pass the same value as the parser's footnote prefix.
`markdownComponents`	`Element map`	`Static`	Maps headings, lists, links, code, task lists, and tables to Mizen elements for any renderer with a components prop.
`Parsing and safety`	`App-owned`	`None`	The app chooses the parser and plugins, skips raw HTML, and keeps URL sanitizing; Mizen ships no parser.

Content

Gives rendered Markdown Mizen's reading layout and element styling, with any parser.

idle

import { Markdown } from "@mizen-labs/ui";

Guidance	Practice
Do	Render the document inside Markdown with markdownComponents, for example through react-markdown with remark-gfm and skipHtml.
Do	Give each document an id and pass it as the parser's footnote prefix.

Guidance	Boundary
Scope	Mizen ships no parser. The app owns parsing, plugins, raw HTML policy, and URL sanitizing for untrusted content.
Scope	Footnote labels share one ID across documents on a page; this is a remark-rehype limitation.

Public props from @mizen-labs/ui. Use exported prop types for the complete TypeScript contract.

Prop	Type	Default	Description
`Markdown.children`	`ReactNode`	`Required`	The rendered document, usually a react-markdown or MDX tree that uses markdownComponents.
`Markdown.id`	`string`	`None`	Anchors the document; pass the same value as the parser's footnote prefix.
`markdownComponents`	`Element map`	`Static`	Maps headings, lists, links, code, task lists, and tables to Mizen elements for any renderer with a components prop.
`Parsing and safety`	`App-owned`	`None`	The app chooses the parser and plugins, skips raw HTML, and keeps URL sanitizing; Mizen ships no parser.

Capability	Behavior
Tables	Use shared Mizen table styles.
Footnotes	Keep references linked to their notes.