Rename Markdown rendering to prose
Follow streamed Markdown into a formatted explanation, inspect a source reference, then ask for a shorter reply.
Recorded from the existing OpenAI capture through the renamed Angular prose workbench in read-only replay. The capture retains its original commit and recording time; lesson IDs and endpoint paths use prose. The original capture used the actual Hashbrown SDK and browser readContext tool. No new provider requests or writes. Playback uses recorded timing with bounded pauses. A source reference does not prove retrieval or correctness. No narration. Read the text walkthrough.
The replay shows the current prose renderer using an existing OpenAI capture. It does not run the earlier APIs in the table below.
The next minor release renames Magic Text to prose. This is a breaking rename with no deprecated exports or compatibility aliases. Rendering, streaming, parser completion and citation behavior stay the same. This guide describes the upcoming release; install its matching core and framework package versions together when it is published.
Update imports and templates
| Previous name | New name |
|---|---|
MagicText | Prose |
MagicTextRenderNode | ProseRenderNode |
MagicTextRenderTextSegment | ProseRenderTextSegment |
MagicTextRenderCaret | ProseRenderCaret |
MagicTextRenderCitation | ProseRenderCitation |
injectMagicTextParser | injectProseParser |
MagicText* types | Prose* types |
<hb-magic-text> | <hb-prose> |
hbMagicTextRender* template attributes | hbProseRender* template attributes |
Keep using exposeMarkdown with the same configuration. Its renderer-related type signatures now use the Prose* types. The underlying Markdown parser still comes from @cacheplane/partial-markdown.
Update styles and links
Replace every hb-magic-text- CSS class prefix with hb-prose-, including root, segment, citation, citation-label and caret hooks. Rename custom animation references from hb-magic-text-segment-enter to hb-prose-segment-enter if you reference that keyframe.
The recipe now lives at /docs/angular/recipes/prose. Workbench lesson IDs and query strings use prose, and the example endpoint is /api/workbench/prose. Replace <hb-magic-text-demo> with <hb-prose-demo> in custom documentation integrations. The old recipe path and lesson ID are removed.
Verify the migration
Build your application to catch old imports, type names and Angular template selectors. Check your custom renderer templates, citation callbacks, streaming caret and segment animations. A stopped or failed partial response still needs parser finalization; isComplete remains separate from request success.