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
parent d9c78ecc73
commit e0a5f57793
2305 changed files with 449355 additions and 0 deletions
@@ -0,0 +1,126 @@
+---
+description: 按文档站、AI 聊天、Mermaid、KaTeX、Monaco 和大文档场景选择正确的 markstream-vue 安装与 peer 依赖组合。
+---
+
+# 安装
+
+如果你只是想先把渲染器跑起来，先装主包，再按能力补装 peer 依赖就够了。
+
+## 1. 最小安装
+
+```bash
+pnpm add markstream-vue
+# 或
+npm install markstream-vue
+# 或
+yarn add markstream-vue
+```
+
+只需要普通 Markdown 渲染时，装完主包就可以继续看 [快速开始](/zh/guide/quick-start)。
+
+## 2. 按能力选择 peer 依赖
+
+| 能力 | 需要的包 | 适用场景 |
+|------|---------|---------|
+| 轻量高亮代码块 | `stream-markdown` | 文档站、SSR、包体积敏感场景 |
+| Monaco 代码块 | `stream-monaco` | 需要复制、预览、展开、字体控制等完整代码块体验 |
+| Mermaid 图表 | `mermaid` | 渲染 `mermaid` fenced code block |
+| D2 图表 | `@terrastruct/d2` | 渲染 `d2` / `d2lang` fenced code block |
+| KaTeX 数学公式 | `katex` | 行内或块级公式 |
+
+## 3. 常见安装配方
+
+### 文档站 / SSR 优先
+
+```bash
+pnpm add markstream-vue stream-markdown
+```
+
+如果你接下来要做的是文档站、内容站或 VitePress 主题，继续看 [文档站与 VitePress 集成](/zh/guide/vitepress-docs-integration)。
+
+### AI / 聊天 UI，且需要更强的代码块和图表体验
+
+```bash
+pnpm add markstream-vue stream-monaco mermaid katex
+```
+
+然后继续看 [AI 聊天与流式输出](/zh/guide/ai-chat-streaming)，里面会把 `nodes` + `final` 的推荐接法和聊天场景调优串起来。
+
+### 图表型内容较多
+
+```bash
+pnpm add markstream-vue mermaid @terrastruct/d2 katex
+```
+
+### 一次性全开
+
+```bash
+pnpm add markstream-vue stream-markdown stream-monaco mermaid @terrastruct/d2 katex
+```
+
+## 4. CSS 顺序和安装同样重要
+
+主包入口已经带了默认样式，但如果你的项目有 reset、Tailwind 或 UnoCSS，通常还是建议显式控制 CSS 顺序：
+
+```css
+@import 'modern-css-reset';
+@tailwind base;
+
+@layer components {
+  @import 'markstream-vue/index.css';
+}
+```
+
+如果你使用数学公式，还要额外引入 KaTeX 的 CSS：
+
+```ts
+import 'katex/dist/katex.min.css'
+```
+
+`stream-monaco`、`mermaid` 和 `@terrastruct/d2` 不需要再从本包额外引入 CSS。
+
+## 5. 功能加载器（只在 CDN 或自定义控制时需要）
+
+装好 peers 以后，默认 loader 已经启用。只有当你手动关闭过，或者想切到 CDN / 自定义 loader 时，才需要显式调用：
+
+```ts twoslash
+import { enableD2, enableKatex, enableMermaid } from 'markstream-vue'
+
+enableMermaid()
+enableKatex()
+enableD2()
+```
+
+## 6. 第一次接入后的检查清单
+
+- 如果你单独使用节点组件，而不是 `MarkdownRender`，请外层包一层 `<div class="markstream-vue">...</div>`。
+- 如果公式不显示，优先检查 `katex` 是否安装、CSS 是否导入。
+- 如果 Monaco 空白，优先检查 worker 打包和浏览器端执行时机。
+- 如果样式错乱，先看 [故障排除](/zh/guide/troubleshooting#css-looks-wrong-start-here)。
+
+## 7. 快速测试
+
+```vue twoslash
+<script setup lang="ts">
+import MarkdownRender from 'markstream-vue'
+
+type MarkdownRenderProps = InstanceType<typeof MarkdownRender>['$props']
+
+const md: MarkdownRenderProps['content'] = '# 你好，markstream-vue！'
+const customId: MarkdownRenderProps['customId'] = 'install-check'
+</script>
+
+<template>
+  <MarkdownRender
+    :content="md"
+    :custom-id="customId"
+  />
+</template>
+```
+
+下一步建议：
+
+- [快速开始](/zh/guide/quick-start)：最小接入
+- [使用与流式渲染](/zh/guide/usage)：`content` 和 `nodes` 的选择
+- [AI 聊天与流式输出](/zh/guide/ai-chat-streaming)：聊天 UI、SSE 与逐 token 输出的完整路径
+- [覆盖内置组件](/zh/guide/component-overrides)：需要业务定制时再进入