BoosAPI/desktop/libs/markstream-vue/docs/zh/index.md at main

Files

T

boos e0a5f57793 feat(desktop): embed BoosAPI Desktop client as a subproject

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.

2026-06-22 11:32:57 +08:00

7.3 KiB

Raw Permalink Blame History

layout, description, hero, features

layout

description

hero

features

home

面向 Vue、React、Angular 和 Nuxt 的流式 Markdown 渲染器，提供安装、VitePress、AI 聊天、组件覆盖与迁移的任务式文档入口。

name

text

tagline

actions

markstream-vue

面向流式输出的 Markdown 渲染器

Vue 3 • Vue 2 • React • Angular • Nuxt

theme	text	link
brand	按场景安装	/zh/guide/installation

theme	text	link
alt	按任务找入口	/zh/guide/

theme	text	link
alt	接入与迁移	/zh/guide/ai-workflows

title	details	link
先装对依赖	按文档站、聊天应用、Monaco 代码块、图表型内容来选择最小 peer 依赖组合。	/zh/guide/installation

title	details	link
选对接入方式	一次性渲染、VitePress 文档站、SSE 或 token 流式输出，推荐的接法并不一样。	/zh/guide/usage

title	details	link
先找对 API 层级	查解析器钩子和作用域时看 API 参考；已经知道组件名时看渲染器与节点组件。	/zh/guide/api

title	details	link
覆盖内置组件	用带作用域的方式替换 `image`、`code_block`、`mermaid`、`link` 等节点渲染器。	/zh/guide/component-overrides

title	details	link
扩展自定义标签	把 `thinking` 这类 HTML-like 标签直接变成自定义节点，而不是自己重写解析器。	/zh/guide/custom-components

title	details	link
更平滑地迁移	从现有 Markdown 方案迁移时，先看哪些能力可以直迁，哪些地方要换思路。	/zh/guide/react-markdown-migration

title	details	link
更好地和 AI 协作	提供适合 Codex、Cursor、Claude Code 等工具的任务模板和 skill 清单。	/zh/guide/ai-workflows

适用于 Vue 3 的流式 Markdown 渲染器，支持 Mermaid 图表、流式代码块对比和高性能大文档处理。

先走最短路径

如果你现在想解决的是...	先看这里	然后看
把第一段渲染跑起来	安装	快速开始
接到文档站或 VitePress 主题里	文档站与 VitePress 集成	自定义标签与高级组件
接入流式输出 / SSE	AI 聊天与流式输出	性能
接入坏了但还不知道是哪一层出问题	按症状排查	排查问题
替换一个内置节点渲染器	覆盖内置组件	渲染器与节点组件
支持 `thinking` 这类可信标签	自定义标签与高级组件	API 参考
做 parser / AST 级改造	API 参考	解析器 API
借助 AI 做接入、迁移或排障	AI / Skills 工作流	从 react-markdown 迁移

按你的角色选入口

我是第一次接触 markstream

先看指南首页，它是按任务组织的总入口。
如果你已经知道框架，只想装对依赖，直接看安装。
如果你想先看到最小 Vue 3 示例，直接看快速开始。

我是在现有项目里接入

用使用与流式渲染决定该走 content 还是 nodes。
如果本质上是在做文档站、内容站或 VitePress 主题，优先走文档站与 VitePress 集成。
如果页面会持续更新，优先走 AI 聊天与流式输出这条完整路径。
如果你还不知道到底是 CSS、peers、SSR 还是自定义标签的问题，先走按症状排查。
如果安装能跑但页面效果不对，先看故障排除。
如果是 Nuxt / SSR，优先看 Nuxt SSR。

我是在做业务定制

已经知道目标组件时，看渲染器与节点组件。
需要安全替换内置节点时，看覆盖内置组件。
需要 parser hooks、AST 改造、作用域覆盖时，看 API 参考和解析器 API。

我想借助 AI 提高效率

看 AI / Skills 工作流，里面有 skills、prompts 和推荐接入顺序。
如果你用的是可读仓库的助手，再配合 AI / LLM 上下文。

选择你的框架

::: tip 框架支持各框架共享同一套核心渲染思路，但入口页会因为 SSR、迁移路径和运行时差异而不同。 :::

框架	最适合先看的页面	适合什么情况	演示
Vue 3 (`markstream-vue`)	指南首页	你要走主线能力最完整的接入路径	在线演示
VitePress 文档站	文档站与 VitePress 集成	你要把渲染器嵌进文档页、内容站或自定义主题	在线演示
Nuxt	Nuxt SSR	你需要处理 client-only 边界、SSR 和 worker	在线演示
Vue 2 (`markstream-vue2`)	Vue 2 快速开始	你还在 Vue 2.6 / 2.7 环境	在线演示
React (`markstream-react`)	React 快速开始	你是 React 用户，或正从 `react-markdown` 迁移	在线演示
Angular (`markstream-angular`)	Angular 快速开始	你使用 standalone Angular 组件	在线演示

常用入口

API 参考：解析器工具、作用域覆盖和渲染流程入口
渲染器与节点组件：导出的渲染器和节点组件参考
按症状排查：先做第一轮定位，再进入对应深度页面
故障排除：CSS/reset 顺序、依赖项和常见问题
功能特性：流式渲染、Mermaid、Monaco、KaTeX 等能力总览
站内搜索：直接搜索页面、组件名和关键字
AI / LLM 上下文：给可读仓库的助手提供项目地图

文档是怎么组织的

开始使用 先解决接入问题：安装、快速开始、流式接法、Props。
自定义 负责解决业务扩展：覆盖组件、自定义标签、解析器钩子、样式与排障。
功能专题 现在默认折叠，主要放代码块、Mermaid、KaTeX、D2、Monaco 等深水区内容。
框架与迁移 适合你已经明确框架或迁移目标之后再进入。

7.3 KiB Raw Permalink Blame History