mirror of
https://github.com/XiaoDaiGua-Ray/ray-template.git
synced 2026-11-19 17:53:36 +08:00
2.8 KiB
2.8 KiB
文档站与可运行示例
用于修改指南、API 参考、导航、主题、旧链接或交互示例。站点开发和预览命令见文档站 README。
| 要查什么 | 先读 | 接着追踪 |
|---|---|---|
| 对外用法、API 或兼容迁移 | 开发指南、API 参考、迁移说明 | 应用与文档联动、共享包边界 |
| 站点主题、导航、源码链接 | VitePress 配置、侧栏、主题 | 版本与仓库链接 |
| 旧文档路径与重定向 | 站内旧路径映射 | 合并站点和旧站跳转产物、构建与部署 |
| 页内交互与源码引用 | 轻量 Vue 示例、后台 iframe 包装 | example.html、独立演示启动与路由、后台示例页面 |
轻量示例通过共享包公开入口运行。需要后台上下文的示例走 example.html 的限定路由和内存缓存;使用和展示同一份运行源码。涉及公开契约时回到所属主题核实,维护指南、示例及迁移说明。
定向验证:pnpm harness verify docs 执行 docs:check,包含类型、站内链接和生产构建。嵌入后台、部署子路径和旧站跳转使用 pnpm pages:build 生成组合产物,再按 README 预览。