Markstream React
Developmentmarkstream-reactMarkstream React is an Agent Skill for development published in the Simon-He95/markstream-vue repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Integrate markstream-react into a React 18+ or Next app. Use when Codex needs to add the React renderer, import CSS correctly, choose between `content` and `nodes`, keep Next client boundaries safe, convert renderer overrides, or prepare a repo for `react-markdown` migration.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/Simon-He95/markstream-vue/blob/HEAD/.agents/skills/markstream-react/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/markstream-react, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Markstream React
Use this skill when the host app is React or Next and the task is to wire Markstream safely.
Workflow
- Confirm the repo is React, Next, or another React-based host.
- Install
markstream-reactplus only the requested optional peers. - Import
markstream-react/index.cssfrom the app shell or client entry. - Start with
content.- For streaming or high-frequency AI output, keep
contentand use built-in smooth streaming first.smoothStreaming="auto"is the default and activates whentypewriter={true}ormaxLiveNodes <= 0.typewriteronly controls the blinking cursor and defaults tofalse.fadecontrols node enter and streamed-text fade animations and defaults totrue.
- Streaming vs recovering history: in chat UIs the same renderer starts streaming and later switches to history when
final={true}.- Streaming:
smoothStreaming="auto",fade={false},typewriter={true}. Smooth pacing handles gradual appearance; fade would flicker. - Recovering history:
smoothStreaming={false},fade={true},typewriter={false}. Content is already complete — pacing would slow it down, but fade gives a polished entry animation. - Dynamic switch:
smoothStreaming={isStreaming ? 'auto' : false},fade={!isStreaming}.
- Streaming:
- Move to
nodes+finalonly for worker-preparsed content, shared AST stores, or custom AST control. - Remember that
htmlPolicynow defaults tosafe, and Mermaid strict mode is on by default throughmermaidProps.
- For streaming or high-frequency AI output, keep
- Respect SSR boundaries in Next.
- Prefer
use client, dynamic imports withssr: false, or other client-only boundaries when browser-only peers are involved.
- Prefer
- Use scoped Markstream overrides before custom parser work.
- Validate with the smallest useful dev, build, or typecheck command.
Default Decisions
- Renderer wiring first, migration cleanup second.
- If the repo already uses
react-markdown, pair this skill withmarkstream-migration. - Prefer
contentwith built-in smooth streaming for most AI chat / token streaming surfaces. - Streaming vs recovering history: when a chat message transitions from streaming to history (e.g.
finalbecomestrue), switch props dynamically —smoothStreaming="auto",fade={false}for streaming;smoothStreaming={false},fade={true}for history. Seedocs/guide/ai-chat-streaming.mdfor full examples. - Move to
nodesonly when another layer owns parsing or AST transforms. - Prefer the smallest client-only boundary that solves the SSR issue.
- Avoid
smoothStreaming={true}for first-screen SSR content unless intentionally starting from blank; auto mode uses the mounted gate. - Keep
htmlPolicy="safe"and Mermaid strict mode unless the request is preserving trusted legacy rendering. - If a trusted surface needs older behavior, use
htmlPolicy="trusted"andmermaidProps={{ isStrict: false }}only on that surface and explain why.
Useful Doc Targets
docs/guide/react-quick-start.mddocs/guide/react-installation.mddocs/guide/react-markdown-migration.mddocs/guide/component-overrides.md