Question 1

What is mdocUI?

Accepted Answer

mdocUI is an open-source library that lets LLMs write interactive UI components (charts, tables, forms, buttons) inline with markdown using Markdoc {% %} tag syntax. Everything streams in real-time.

Question 2

Which LLM providers does it work with?

Accepted Answer

Any provider that streams text — OpenAI, Anthropic, Google, Mistral, local models, or any custom API. mdocUI parses the output, it doesn't care where it comes from.

Question 3

Do I need to train the model on the syntax?

Accepted Answer

No. Markdoc {% %} syntax is already in most LLM training data (Stripe docs, Cloudflare docs). Just include the auto-generated system prompt from generatePrompt() and models write it correctly.

Question 4

Can I use my own components?

Accepted Answer

Yes. Pass a components prop to the Renderer with your own React components (shadcn, Radix, custom). You can override any of the 24 built-in components or add new ones.

Question 5

Is it production ready?

Accepted Answer

mdocUI is in alpha (0.6.x). The core API is stabilizing but may change between minor versions. We follow semver and will freeze the API at v1.0.

Question 6

How does streaming work?

Accepted Answer

The parser processes tokens character-by-character using a state machine. As soon as {% is detected, it switches from prose mode to tag mode. No buffering, no regex, no lookahead — components appear the moment the closing tag arrives.

Question 7

What frameworks are supported?

Accepted Answer

@mdocui/core is framework-agnostic. @mdocui/react is the first renderer. Vue and Svelte renderers are on the roadmap.

ShopMetrics

Welcome to ShopMetrics