markstream-vue

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Markstream Vue 3

Markstream Vue 3

Use this skill when the host app is plain Vue 3, typically Vite-based, and not Nuxt.
当宿主应用为原生Vue 3(通常基于Vite构建)且非Nuxt项目时使用本skill。

Workflow

工作流程

  1. Confirm the repo is Vue 3 and not Nuxt.
  2. Install
    markstream-vue
    plus only the optional peers required by the requested features.
  3. Import
    markstream-vue/index.css
    after resets.
    • In Tailwind or UnoCSS projects, keep Markstream styles inside
      @layer components
      .
  4. Start with
    <MarkdownRender :content="markdown" />
    .
    • Switch to
      nodes
      plus
      final
      only for streaming, SSE, or high-frequency updates.
  5. Use
    custom-id
    plus scoped
    setCustomComponents(...)
    for overrides.
  6. Validate with the smallest useful dev, build, or typecheck command.
  1. 确认代码库为Vue 3项目,且不是Nuxt项目。
  2. 安装
    markstream-vue
    以及所需功能对应的可选对等依赖。
  3. 在重置样式之后导入
    markstream-vue/index.css
    • 在Tailwind或UnoCSS项目中,将Markstream样式放在
      @layer components
      内部。
  4. 先使用
    <MarkdownRender :content="markdown" />
    • 仅在流式渲染、SSE或高频更新场景下切换使用
      nodes
      final
      的模式。
  5. 使用
    custom-id
    加作用域方法
    setCustomComponents(...)
    实现组件覆盖。
  6. 使用最简可用的开发、构建或类型检查命令验证配置是否生效。

Default Decisions

默认决策

  • Vue 3 apps default to
    content
    .
  • Prefer local component registration unless the repo already uses a shared plugin entry.
  • If the host is actually Nuxt, leave SSR-specific setup to
    markstream-nuxt
    .
  • Vue 3应用默认使用
    content
    模式。
  • 优先使用局部组件注册,除非代码库已经使用了统一的插件入口。
  • 如果宿主实际是Nuxt项目,将SSR相关的配置交给
    markstream-nuxt
    处理。

Useful Doc Targets

有用的文档地址

  • docs/guide/quick-start.md
  • docs/guide/installation.md
  • docs/guide/usage.md
  • docs/guide/component-overrides.md
  • docs/guide/quick-start.md
  • docs/guide/installation.md
  • docs/guide/usage.md
  • docs/guide/component-overrides.md