菜单
Run and verify this VitePress documentation site locally — start the dev server to eyeball rendered pages, or run a production build to confirm content changes don't break the site. Use after editing guide/** Markdown, the theme, or .vitepress/config.mts, or whenever asked to preview/run/build the docs.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | preview-docs |
| description | Run and verify this VitePress documentation site locally — start the dev server to eyeball rendered pages, or run a production build to confirm content changes don't break the site. Use after editing guide/** Markdown, the theme, or .vitepress/config.mts, or whenever asked to preview/run/build the docs. |
This repo is a VitePress site; the only dependency is VitePress itself.
npm install
npm run docs:dev
Starts a hot-reloading dev server (default http://localhost:5173). Best for checking rendering, sidebar placement, images, links, and any raw HTML (e.g. <iframe> embeds). If you need the user to interact with the running server, ask them to launch it with a leading ! in their prompt so its output lands in the session.
npm run docs:build
Compiles into .vitepress/dist (gitignored). Run this after non-trivial content or config changes — it surfaces broken frontmatter, dead sidebar links, and malformed Markdown/HTML. A clean run ends with build complete. Then optionally:
npm run docs:preview
to serve the built output.
.vitepress/config.mts), renders, images load, internal links resolve./guide/public/images/<section>/<page-slug>/<file>.webp and actually present on disk.<iframe> embeds render responsively (handled by .vp-doc iframe rules in .vitepress/theme/custom.css).docs:build completes without errors or dead-link warnings.docs:dev, and confirm build integrity via docs:build.ctx_batch_execute / ctx_execute) over large raw greps.