Markstream Nuxt
Developmentmarkstream-nuxtMarkstream Nuxt is an Agent Skill for development published in the Simon-He95/markstream-vue repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Integrate markstream-vue into a Nuxt 3 or Nuxt 4 app. Use when Codex needs client-only boundaries, SSR-safe setup, browser-only peer gating, worker-aware initialization, renderer `mode` selection, or a safe `MarkdownRender` integration inside pages, components, or Nuxt plugins.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/Simon-He95/markstream-vue/blob/HEAD/.agents/skills/markstream-nuxt/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/markstream-nuxt, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Markstream Nuxt
Use this skill when the host app is Nuxt and SSR boundaries matter.
Workflow
- Confirm the repo is Nuxt 3 or 4.
- Install
markstream-vueplus only the optional peers required by the requested features. - Keep browser-only peers behind client-only boundaries.
- Prefer
<client-only>wrappers,.clientplugins, or guarded setup paths.
- Prefer
- Import
markstream-vue/index.cssfrom a client-safe app shell or plugin.- The root JS import does not inject styles; use
markstream-vue/index.cssormarkstream-vue/index.px.cssexplicitly.
- The root JS import does not inject styles; use
- Start with
content, choose the renderer mode by surface, and move tonodesplusfinalonly when the UI needs custom AST control.- Use
mode="chat"for AI chat or SSE output. It uses lightweight batches,<pre>code rendering by default,fade=false, andmax-live-nodes=0;smooth-streaming="auto"paces visible output. - Use
mode="docs"for rich document surfaces. It is the default, enables larger batches, tooltips, fade, and Monaco-backed code blocks when the peer is installed. - Use
mode="minimal"for lightweight non-chat surfaces. typewriteronly controls the blinking cursor and defaults tofalse.- When overriding mode defaults on a high-frequency stream, pair smooth streaming with
:fade="false"to avoid delta fade stacking with high-commit pacing. - Streaming vs recovering history: in chat UIs the same
MarkdownRenderstarts streaming and later switches to history whenfinal=true.- Streaming:
mode="chat",smooth-streaming="auto",:fade="false",typewriter=true. - Recovering/completed chat history: keep
mode="chat"on the same chat row; use:smooth-streaming="false",typewriter=false, and only set:fade="true"when the host explicitly wants a history-entry animation. - Use
mode="minimal"for lightweight non-chat recovered content, and usemode="docs"only for rich document surfaces.
- Streaming:
- In SSR, avoid
smooth-streaming="true"on first-screen content; the mounted gate insideautoprevents hydration mismatch. - Remember that
html-policynow defaults tosafe, and Mermaid strict mode is on by default throughmermaid-props.
- Use
- Validate with the smallest relevant Nuxt dev, build, or typecheck command.
Default Decisions
- SSR safety comes before feature completeness.
- Omit
modeonly when the surface should use rich docs defaults. - Smooth streaming is SSR-safe in
automode (the default) because it gates on mount. Do not usesmooth-streaming="true"for first-screen SSR content — it bypasses the mounted gate and can cause hydration mismatch or blank flash. - Avoid import-time access to browser globals from server code paths.
- Treat Monaco, Mermaid workers, and similar heavy peers as client-only unless the repo already has a proven SSR pattern.
- Keep
html-policy="safe"and Mermaid strict mode unless the task is preserving trusted legacy rendering. - If a trusted client-only surface needs older behavior, opt out locally with
html-policy="trusted"and:mermaid-props="{ isStrict: false }", and document why that surface is trusted.
Useful Doc Targets
docs/nuxt-ssr.mddocs/guide/installation.mddocs/guide/usage.mddocs/guide/troubleshooting.md