Customize Markstream renderer nodes without global state
Customize Markstream Markdown renderer nodes and trusted tags without replacing the parser or leaking global state across Vue, React, Svelte, and Angular apps.
Why it matters
Override built-in Markdown rendering components or add trusted custom tags in Markstream parsers across React, Vue, Svelte, and Angular frameworks while maintaining scoped state and security boundaries.
Outcomes
What it gets done
Replace built-in nodes like image, link, code_block, or inline_code with custom components
Render trusted HTML-like tags such as thinking blocks with scoped component mappings
Preserve streaming props, identity keys, and theme state during component overrides
Nest renderers for trusted tag bodies containing Markdown without duplicate streaming loops
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/ag-markstream-custom-components | bash Overview
Markstream Custom Components
Overrides specific Markdown renderer nodes or adds trusted custom tags with scoped, framework-specific registration APIs. Use to replace built-in nodes (image, link, code_block, mermaid, inline_code), render trusted tags, or scope overrides to one renderer or app without replacing the parser.
What it does
Markstream Custom Components lets you override specific Markdown renderer nodes (image, link, code_block, mermaid, inline_code) or add trusted custom HTML-like tags (such as thinking) without replacing the entire parser or polluting global renderer state. It provides scoped, framework-specific registration APIs for Vue, Vue 2, Svelte, Angular, and React that keep customizations isolated to individual renderers or application contexts.
When to use - and when NOT to
Use this skill to replace built-ins such as image, link, code_block, mermaid, or inline_code; render trusted tags such as thinking; or scope overrides to one renderer or app. Use parser transforms only when token or AST reshaping is required.
Do not use this skill when you need arbitrary remark/rehype AST transforms - component overrides cannot reproduce those. Avoid it for container overrides unless you are prepared to handle careful child rendering and accessibility review.
Inputs and outputs
You provide a custom component function or class that receives node props (content, attributes, children) and a scoped registration ID. The skill registers your component against a specific node type or trusted tag name.
You receive a Markdown renderer that invokes your custom component whenever it encounters the registered node or tag, while all other Markdown elements render with default behavior. The renderer preserves node/loading props, identity keys, scope IDs, theme state, and preview-height estimates for async diagrams.
Integrations
- markstream-react: Use
setCustomComponents(customId, mapping)for global scoped registration or passstreamingComponentsfor parser-backed nodes andhtmlComponentsfor sanitized attributes plus children. - Vue, Vue 2: Use
setCustomComponents(customId, mapping)for scoped component registration. - Svelte, Angular: Use
setCustomComponents(customId, mapping)or pass renderer-local maps directly to the component.
Example
import MarkdownRender, {
type NodeComponentProps,
setCustomComponents,
} from 'markstream-react'
import 'markstream-react/index.css'
function ThinkingNode({ node }: NodeComponentProps<any>) {
return <details><summary>Thinking</summary>{node.content}</details>
}
setCustomComponents('assistant-panel', { thinking: ThinkingNode })
export function Answer({ markdown }: { markdown: string }) {
return (
<MarkdownRender
content={markdown}
customId="assistant-panel"
customHtmlTags={['thinking']}
htmlPolicy="safe"
/>
)
}
Workflow
Before changing dependencies or source files, inspect the existing package manager and project conventions, preview the intended edits, and obtain explicit user approval.
- Classify the change as a built-in override, trusted tag, or parser transform.
- Prefer scoped mappings. Vue, Vue 2, Svelte, and Angular can use
setCustomComponents(customId, mapping); Svelte and Angular can also pass renderer-local maps. - In React, prefer
streamingComponentsfor parser-backed nodes andhtmlComponentsfor sanitized attributes plus children. - Start with leaf nodes before containers that must preserve children.
- For trusted tag bodies containing Markdown, use a nested renderer with the same allowlist. Do not add a second smooth-streaming loop.
- Preserve node/loading props, identity keys, scope IDs, theme state, and preview-height estimates for async diagrams.
- Remove temporary scoped registrations on cleanup and validate repeated and nested tags.
Security note: Treat custom HTML-like tags as trusted input only. Keep safe HTML enabled and do not pass unsanitized attributes into host components.
Source README
Markstream Custom Components
Overview
Customize specific Markstream nodes or trusted custom tags without replacing the parser or leaking global renderer state. Read references/patterns.md first.
When to Use
Use to replace built-ins such as image, link, code_block, mermaid, or inline_code; render trusted tags such as thinking; or scope overrides to one renderer or app. Use parser transforms only when token or AST reshaping is required.
Workflow
Before changing dependencies or source files, inspect the existing package manager and project conventions, preview the intended edits, and obtain explicit user approval.
- Classify the change as a built-in override, trusted tag, or parser transform.
- Prefer scoped mappings. Vue, Vue 2, Svelte, and Angular can use
setCustomComponents(customId, mapping); Svelte and Angular can also pass renderer-local maps. - In React, prefer
streamingComponentsfor parser-backed nodes andhtmlComponentsfor sanitized attributes plus children. - Start with leaf nodes before containers that must preserve children.
- For trusted tag bodies containing Markdown, use a nested renderer with the same allowlist. Do not add a second smooth-streaming loop.
- Preserve node/loading props, identity keys, scope IDs, theme state, and preview-height estimates for async diagrams.
- Remove temporary scoped registrations on cleanup and validate repeated and nested tags.
Example
import MarkdownRender, {
type NodeComponentProps,
setCustomComponents,
} from 'markstream-react'
import 'markstream-react/index.css'
function ThinkingNode({ node }: NodeComponentProps<any>) {
return <details><summary>Thinking</summary>{node.content}</details>
}
setCustomComponents('assistant-panel', { thinking: ThinkingNode })
export function Answer({ markdown }: { markdown: string }) {
return (
<MarkdownRender
content={markdown}
customId="assistant-panel"
customHtmlTags={['thinking']}
htmlPolicy="safe"
/>
)
}
Limitations
- Component overrides cannot reproduce arbitrary remark/rehype transforms.
- Container overrides require careful child rendering and accessibility review.
- Framework registration APIs are not interchangeable.
Security & Safety Notes
Treat custom HTML-like tags as trusted input only. Keep safe HTML enabled and do not pass unsanitized attributes into host components.
Discussion
Questions & comments ยท 0
Sign In Sign in to leave a comment.