boos
e0a5f57793
Vendor the rebranded BoosAPI Desktop client (Tauri + Vue) into metapi as a monorepo subdirectory under desktop/. Source only — node_modules, dist, Cargo target and the upstream .git history are excluded. desktop/ keeps its own independent Cargo workspace (desktop/src-tauri with crates/*); it is not part of the backend boosapi crate, so a `cargo check` at the metapi root still compiles only the backend. Build the desktop app from desktop/src-tauri per desktop/README.md. Note: app icons are still placeholder assets pending the final BoosAPI logo. The updater signing keys live outside the repo and are not included.
4.2 KiB
4.2 KiB
description
| description |
|---|
| Task-first guide for choosing the right markstream-vue path across installation, streaming usage, VitePress docs sites, component overrides, and migration. |
Guide
This guide is organized by task first, framework second. Start with the shortest path that matches what you are trying to do today.
I Want To Get Something Working Quickly
- Install by scenario for peer-dependency decisions and CSS order.
- Quick Start for the smallest Vue 3 example.
- Usage & Streaming if you need to choose between
contentandnodes. - Docs Site & VitePress if you are wiring stable Markdown pages, theme CSS, and custom tags inside a docs site.
- AI Chat & Streaming if the UI updates continuously and you need one guided path for peers, parsing, performance, and troubleshooting.
- Troubleshooting by Symptom if you do not yet know whether the issue is CSS, peers, SSR, or custom-tag wiring.
- Props & Options if the renderer already works and you only need configuration.
I Want To Customize Rendering
- API Reference for parser helpers, scoping, and render-pipeline entry points.
- Renderer & Node Components for exported renderer and node component reference.
- Override Built-in Components to replace
image,code_block,mermaid,link, or other built-ins. - Custom Tags & Advanced Components to support trusted tags such as
thinking. - Advanced Parser Hooks and Parser API for token or AST-level customization.
I Want To Adopt It In An Existing App
- Nuxt SSR for browser-only peers and client-only guards.
- AI / Skills workflows for copyable prompts, reusable checklists, and migration tasks.
- Migrate from react-markdown and the Migration Cookbook for React teams.
- Troubleshooting when the install works but styles, peers, or SSR do not.
Framework Entry Points
Vue 3 (markstream-vue) ⭐ Recommended
| Page | Description |
|---|---|
| Installation | Install the package and only the peers you actually need |
| Quick Start | Render your first Markdown document |
| Usage & Streaming | Decide between content and nodes |
| Docs Site & VitePress | Guided path for docs pages, enhanceApp, trusted tags, and CSS order |
| AI Chat & Streaming | Guided path for chat UIs, SSE, and token-by-token output |
| API Reference | Parser helpers, scoping, and render-pipeline entry points |
| Renderer & Node Components | Renderer and node component reference |
| Customization | Override built-ins and add custom tags |
Vue 2 (markstream-vue2)
| Page | Description |
|---|---|
| Installation | Vue 2 specific setup |
| Quick Start | Vue 2 examples |
| Components & API | Vue 2 component reference |
React (markstream-react)
| Page | Description |
|---|---|
| Installation | React specific setup |
| Quick Start | React examples |
| React Components | React renderer and node components |
| Migrate from react-markdown | Migration path for existing React Markdown apps |
| Migration Cookbook | Before/after recipes for common migration scenarios |
Angular (markstream-angular)
| Page | Description |
|---|---|
| Installation | Angular specific setup |
| Quick Start | Standalone Angular examples |
Nuxt
- Nuxt SSR Guide for client-only boundaries, workers, and browser-only peers.