opencode-agent-kit 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (361) hide show
  1. package/README.md +796 -0
  2. package/bin/commands/init.mjs +221 -0
  3. package/bin/init.mjs +21 -0
  4. package/package.json +22 -0
  5. package/template/.opencode/agent-docs/backend/README.md +0 -0
  6. package/template/.opencode/agent-docs/backend/node/BACKEND_PATTERNS.md +82 -0
  7. package/template/.opencode/agent-docs/backend/node/BACKEND_QUICK_START.md +49 -0
  8. package/template/.opencode/agent-docs/frontend/next/README.md +0 -0
  9. package/template/.opencode/agent-docs/frontend/nuxt/API_PATTERNS.md +807 -0
  10. package/template/.opencode/agent-docs/frontend/nuxt/CHEATSHEET.md +676 -0
  11. package/template/.opencode/agent-docs/frontend/nuxt/COMPLETION_REPORT.md +613 -0
  12. package/template/.opencode/agent-docs/frontend/nuxt/EXAMPLES.md +956 -0
  13. package/template/.opencode/agent-docs/frontend/nuxt/INDEX.md +596 -0
  14. package/template/.opencode/agent-docs/frontend/nuxt/MCP_GUIDE.md +881 -0
  15. package/template/.opencode/agent-docs/frontend/nuxt/MENTOR_CURRICULUM_30_DAYS.md +256 -0
  16. package/template/.opencode/agent-docs/frontend/nuxt/MENTOR_CURRICULUM_CHECKLIST.md +156 -0
  17. package/template/.opencode/agent-docs/frontend/nuxt/MENTOR_WEEKLY_ASSIGNMENTS.md +191 -0
  18. package/template/.opencode/agent-docs/frontend/nuxt/QUICK_START.md +509 -0
  19. package/template/.opencode/agent-docs/frontend/nuxt/README.md +506 -0
  20. package/template/.opencode/agent-docs/frontend/nuxt/README_AGENTS.md +140 -0
  21. package/template/.opencode/agent-docs/frontend/nuxt/README_DOCS.md +65 -0
  22. package/template/.opencode/agent-docs/frontend/nuxt/SUMMARY.md +474 -0
  23. package/template/.opencode/agent-docs/frontend/nuxt/TEAM_OPERATING_GUIDE.md +54 -0
  24. package/template/.opencode/agent-docs/frontend/nuxt/TESTING_GUIDE.md +904 -0
  25. package/template/.opencode/agent-docs/frontend/nuxt/WORKFLOWS.md +758 -0
  26. package/template/.opencode/agent-docs/frontend/react/API_PATTERNS.md +187 -0
  27. package/template/.opencode/agent-docs/frontend/react/CHEATSHEET.md +87 -0
  28. package/template/.opencode/agent-docs/frontend/react/INDEX.md +45 -0
  29. package/template/.opencode/agent-docs/frontend/react/QUICK_START.md +43 -0
  30. package/template/.opencode/agent-docs/frontend/react/README.md +159 -0
  31. package/template/.opencode/agent-docs/frontend/vue/README.md +0 -0
  32. package/template/.opencode/agent-docs/mobile/android/README.md +45 -0
  33. package/template/.opencode/agent-docs/mobile/flutter/README.md +44 -0
  34. package/template/.opencode/agents/android-developer.md +418 -0
  35. package/template/.opencode/agents/code-igniter-3-fullstack.md +345 -0
  36. package/template/.opencode/agents/code-reviewer.md +517 -0
  37. package/template/.opencode/agents/database-specialist.md +455 -0
  38. package/template/.opencode/agents/devops-specialist.md +562 -0
  39. package/template/.opencode/agents/flutter-developer.md +556 -0
  40. package/template/.opencode/agents/it-leader.md +911 -0
  41. package/template/.opencode/agents/laravel-advanced.md +691 -0
  42. package/template/.opencode/agents/node-backend-developer.md +343 -0
  43. package/template/.opencode/agents/nuxt-frontend-developer-mentor.md +402 -0
  44. package/template/.opencode/agents/nuxt-frontend-developer.md +1573 -0
  45. package/template/.opencode/agents/react-frontend-developer.md +1017 -0
  46. package/template/.opencode/agents/seo-specialist.md +681 -0
  47. package/template/.opencode/agents/ui-ux-designer.md +783 -0
  48. package/template/.opencode/commands/android-build/command.md +25 -0
  49. package/template/.opencode/commands/android-test/command.md +23 -0
  50. package/template/.opencode/commands/build-fix.md +29 -0
  51. package/template/.opencode/commands/checkpoint.md +74 -0
  52. package/template/.opencode/commands/code-review.md +40 -0
  53. package/template/.opencode/commands/e2e.md +363 -0
  54. package/template/.opencode/commands/eval.md +120 -0
  55. package/template/.opencode/commands/evolve.md +193 -0
  56. package/template/.opencode/commands/flutter-build/command.md +25 -0
  57. package/template/.opencode/commands/flutter-test/command.md +24 -0
  58. package/template/.opencode/commands/go-build.md +183 -0
  59. package/template/.opencode/commands/go-review.md +148 -0
  60. package/template/.opencode/commands/go-test.md +268 -0
  61. package/template/.opencode/commands/gpc-release/command.md +30 -0
  62. package/template/.opencode/commands/instinct-export.md +91 -0
  63. package/template/.opencode/commands/instinct-import.md +142 -0
  64. package/template/.opencode/commands/instinct-status.md +86 -0
  65. package/template/.opencode/commands/learn.md +70 -0
  66. package/template/.opencode/commands/multi-backend.md +158 -0
  67. package/template/.opencode/commands/multi-execute.md +310 -0
  68. package/template/.opencode/commands/multi-frontend.md +158 -0
  69. package/template/.opencode/commands/multi-plan.md +261 -0
  70. package/template/.opencode/commands/multi-workflow.md +183 -0
  71. package/template/.opencode/commands/orchestrate.md +172 -0
  72. package/template/.opencode/commands/plan.md +113 -0
  73. package/template/.opencode/commands/pm2.md +271 -0
  74. package/template/.opencode/commands/python-review.md +297 -0
  75. package/template/.opencode/commands/refactor-clean.md +28 -0
  76. package/template/.opencode/commands/sessions.md +305 -0
  77. package/template/.opencode/commands/setup-pm.md +80 -0
  78. package/template/.opencode/commands/skill-create.md +174 -0
  79. package/template/.opencode/commands/tdd.md +326 -0
  80. package/template/.opencode/commands/test-coverage.md +27 -0
  81. package/template/.opencode/commands/update-codemaps.md +17 -0
  82. package/template/.opencode/commands/update-docs.md +31 -0
  83. package/template/.opencode/commands/verify.md +59 -0
  84. package/template/.opencode/config.example.json +309 -0
  85. package/template/.opencode/config.json +341 -0
  86. package/template/.opencode/contexts/dev.md +20 -0
  87. package/template/.opencode/contexts/research.md +26 -0
  88. package/template/.opencode/contexts/review.md +22 -0
  89. package/template/.opencode/hooks/hooks.json +169 -0
  90. package/template/.opencode/instructions/INSTRUCTIONS.md +388 -0
  91. package/template/.opencode/package.json +5 -0
  92. package/template/.opencode/rules/README.md +82 -0
  93. package/template/.opencode/rules/android/gradle.md +62 -0
  94. package/template/.opencode/rules/android/testing.md +27 -0
  95. package/template/.opencode/rules/common/agents.md +49 -0
  96. package/template/.opencode/rules/common/coding-style.md +48 -0
  97. package/template/.opencode/rules/common/git-workflow.md +45 -0
  98. package/template/.opencode/rules/common/hooks.md +30 -0
  99. package/template/.opencode/rules/common/patterns.md +31 -0
  100. package/template/.opencode/rules/common/performance.md +55 -0
  101. package/template/.opencode/rules/common/security.md +29 -0
  102. package/template/.opencode/rules/common/testing.md +29 -0
  103. package/template/.opencode/rules/flutter/state-management.md +57 -0
  104. package/template/.opencode/rules/flutter/testing.md +42 -0
  105. package/template/.opencode/rules/golang/coding-style.md +26 -0
  106. package/template/.opencode/rules/golang/hooks.md +11 -0
  107. package/template/.opencode/rules/golang/patterns.md +39 -0
  108. package/template/.opencode/rules/golang/security.md +28 -0
  109. package/template/.opencode/rules/golang/testing.md +25 -0
  110. package/template/.opencode/rules/mobile/performance.md +36 -0
  111. package/template/.opencode/rules/python/coding-style.md +37 -0
  112. package/template/.opencode/rules/python/hooks.md +14 -0
  113. package/template/.opencode/rules/python/patterns.md +34 -0
  114. package/template/.opencode/rules/python/security.md +25 -0
  115. package/template/.opencode/rules/python/testing.md +33 -0
  116. package/template/.opencode/rules/typescript/coding-style.md +58 -0
  117. package/template/.opencode/rules/typescript/hooks.md +15 -0
  118. package/template/.opencode/rules/typescript/patterns.md +45 -0
  119. package/template/.opencode/rules/typescript/security.md +21 -0
  120. package/template/.opencode/rules/typescript/testing.md +11 -0
  121. package/template/.opencode/skills/api-documentation/SKILL.md +188 -0
  122. package/template/.opencode/skills/backend-patterns/SKILL.md +587 -0
  123. package/template/.opencode/skills/building-components/SKILL.md +37 -0
  124. package/template/.opencode/skills/building-components/references/accessibility.mdx +819 -0
  125. package/template/.opencode/skills/building-components/references/as-child.mdx +324 -0
  126. package/template/.opencode/skills/building-components/references/composition.mdx +239 -0
  127. package/template/.opencode/skills/building-components/references/data-attributes.mdx +413 -0
  128. package/template/.opencode/skills/building-components/references/definitions.mdx +258 -0
  129. package/template/.opencode/skills/building-components/references/design-tokens.mdx +57 -0
  130. package/template/.opencode/skills/building-components/references/docs.mdx +155 -0
  131. package/template/.opencode/skills/building-components/references/marketplaces.mdx +144 -0
  132. package/template/.opencode/skills/building-components/references/npm.mdx +166 -0
  133. package/template/.opencode/skills/building-components/references/polymorphism.mdx +583 -0
  134. package/template/.opencode/skills/building-components/references/principles.mdx +61 -0
  135. package/template/.opencode/skills/building-components/references/registry.mdx +169 -0
  136. package/template/.opencode/skills/building-components/references/state.mdx +99 -0
  137. package/template/.opencode/skills/building-components/references/styling.mdx +286 -0
  138. package/template/.opencode/skills/building-components/references/types.mdx +191 -0
  139. package/template/.opencode/skills/clickhouse-io/SKILL.md +429 -0
  140. package/template/.opencode/skills/coding-standards/SKILL.md +520 -0
  141. package/template/.opencode/skills/configure-ecc/SKILL.md +298 -0
  142. package/template/.opencode/skills/continuous-learning/SKILL.md +110 -0
  143. package/template/.opencode/skills/continuous-learning/config.json +18 -0
  144. package/template/.opencode/skills/continuous-learning/evaluate-session.sh +60 -0
  145. package/template/.opencode/skills/continuous-learning-v2/SKILL.md +284 -0
  146. package/template/.opencode/skills/continuous-learning-v2/agents/observer.md +137 -0
  147. package/template/.opencode/skills/continuous-learning-v2/agents/start-observer.sh +134 -0
  148. package/template/.opencode/skills/continuous-learning-v2/config.json +41 -0
  149. package/template/.opencode/skills/continuous-learning-v2/hooks/observe.sh +153 -0
  150. package/template/.opencode/skills/continuous-learning-v2/scripts/instinct-cli.py +489 -0
  151. package/template/.opencode/skills/continuous-learning-v2/scripts/test_parse_instinct.py +82 -0
  152. package/template/.opencode/skills/dart-add-unit-test/SKILL.md +122 -0
  153. package/template/.opencode/skills/dart-build-cli-app/SKILL.md +185 -0
  154. package/template/.opencode/skills/dart-collect-coverage/SKILL.md +141 -0
  155. package/template/.opencode/skills/dart-fix-runtime-errors/SKILL.md +166 -0
  156. package/template/.opencode/skills/dart-generate-test-mocks/SKILL.md +155 -0
  157. package/template/.opencode/skills/dart-migrate-to-checks-package/SKILL.md +126 -0
  158. package/template/.opencode/skills/dart-resolve-package-conflicts/SKILL.md +116 -0
  159. package/template/.opencode/skills/dart-run-static-analysis/SKILL.md +104 -0
  160. package/template/.opencode/skills/dart-use-pattern-matching/SKILL.md +146 -0
  161. package/template/.opencode/skills/django-patterns/SKILL.md +733 -0
  162. package/template/.opencode/skills/django-security/SKILL.md +592 -0
  163. package/template/.opencode/skills/django-tdd/SKILL.md +728 -0
  164. package/template/.opencode/skills/django-verification/SKILL.md +460 -0
  165. package/template/.opencode/skills/eval-harness/SKILL.md +227 -0
  166. package/template/.opencode/skills/firebase-basics/SKILL.md +103 -0
  167. package/template/.opencode/skills/firebase-basics/references/additional-skills.md +113 -0
  168. package/template/.opencode/skills/firebase-basics/references/cli-usage.md +31 -0
  169. package/template/.opencode/skills/firebase-basics/references/client-library-usage.md +45 -0
  170. package/template/.opencode/skills/firebase-basics/references/core-concepts.md +61 -0
  171. package/template/.opencode/skills/firebase-basics/references/iac-usage.md +40 -0
  172. package/template/.opencode/skills/firebase-basics/references/iam-security.md +74 -0
  173. package/template/.opencode/skills/firebase-basics/references/mcp-usage.md +63 -0
  174. package/template/.opencode/skills/flutter/SKILL.md +292 -0
  175. package/template/.opencode/skills/flutter-add-integration-test/SKILL.md +163 -0
  176. package/template/.opencode/skills/flutter-add-widget-preview/SKILL.md +145 -0
  177. package/template/.opencode/skills/flutter-add-widget-test/SKILL.md +154 -0
  178. package/template/.opencode/skills/flutter-apply-architecture-best-practices/SKILL.md +162 -0
  179. package/template/.opencode/skills/flutter-build-responsive-layout/SKILL.md +139 -0
  180. package/template/.opencode/skills/flutter-fix-layout-issues/SKILL.md +130 -0
  181. package/template/.opencode/skills/flutter-implement-json-serialization/SKILL.md +153 -0
  182. package/template/.opencode/skills/flutter-setup-declarative-routing/SKILL.md +255 -0
  183. package/template/.opencode/skills/flutter-setup-localization/SKILL.md +210 -0
  184. package/template/.opencode/skills/flutter-use-http-package/SKILL.md +174 -0
  185. package/template/.opencode/skills/frontend-design/SKILL.md +89 -0
  186. package/template/.opencode/skills/frontend-patterns/SKILL.md +631 -0
  187. package/template/.opencode/skills/golang-patterns/SKILL.md +673 -0
  188. package/template/.opencode/skills/golang-testing/SKILL.md +719 -0
  189. package/template/.opencode/skills/impeccable/SKILL.md +165 -0
  190. package/template/.opencode/skills/impeccable/agents/impeccable-asset-producer.md +101 -0
  191. package/template/.opencode/skills/impeccable/reference/adapt.md +190 -0
  192. package/template/.opencode/skills/impeccable/reference/animate.md +175 -0
  193. package/template/.opencode/skills/impeccable/reference/audit.md +133 -0
  194. package/template/.opencode/skills/impeccable/reference/bolder.md +113 -0
  195. package/template/.opencode/skills/impeccable/reference/brand.md +118 -0
  196. package/template/.opencode/skills/impeccable/reference/clarify.md +174 -0
  197. package/template/.opencode/skills/impeccable/reference/codex.md +105 -0
  198. package/template/.opencode/skills/impeccable/reference/cognitive-load.md +106 -0
  199. package/template/.opencode/skills/impeccable/reference/color-and-contrast.md +105 -0
  200. package/template/.opencode/skills/impeccable/reference/colorize.md +154 -0
  201. package/template/.opencode/skills/impeccable/reference/craft.md +123 -0
  202. package/template/.opencode/skills/impeccable/reference/critique.md +273 -0
  203. package/template/.opencode/skills/impeccable/reference/delight.md +302 -0
  204. package/template/.opencode/skills/impeccable/reference/distill.md +111 -0
  205. package/template/.opencode/skills/impeccable/reference/document.md +427 -0
  206. package/template/.opencode/skills/impeccable/reference/extract.md +69 -0
  207. package/template/.opencode/skills/impeccable/reference/harden.md +347 -0
  208. package/template/.opencode/skills/impeccable/reference/heuristics-scoring.md +234 -0
  209. package/template/.opencode/skills/impeccable/reference/interaction-design.md +195 -0
  210. package/template/.opencode/skills/impeccable/reference/layout.md +141 -0
  211. package/template/.opencode/skills/impeccable/reference/live.md +622 -0
  212. package/template/.opencode/skills/impeccable/reference/motion-design.md +109 -0
  213. package/template/.opencode/skills/impeccable/reference/onboard.md +234 -0
  214. package/template/.opencode/skills/impeccable/reference/optimize.md +258 -0
  215. package/template/.opencode/skills/impeccable/reference/overdrive.md +130 -0
  216. package/template/.opencode/skills/impeccable/reference/personas.md +179 -0
  217. package/template/.opencode/skills/impeccable/reference/polish.md +242 -0
  218. package/template/.opencode/skills/impeccable/reference/product.md +62 -0
  219. package/template/.opencode/skills/impeccable/reference/quieter.md +99 -0
  220. package/template/.opencode/skills/impeccable/reference/responsive-design.md +114 -0
  221. package/template/.opencode/skills/impeccable/reference/shape.md +165 -0
  222. package/template/.opencode/skills/impeccable/reference/spatial-design.md +100 -0
  223. package/template/.opencode/skills/impeccable/reference/teach.md +156 -0
  224. package/template/.opencode/skills/impeccable/reference/typeset.md +124 -0
  225. package/template/.opencode/skills/impeccable/reference/typography.md +159 -0
  226. package/template/.opencode/skills/impeccable/reference/ux-writing.md +107 -0
  227. package/template/.opencode/skills/impeccable/scripts/cleanup-deprecated.mjs +284 -0
  228. package/template/.opencode/skills/impeccable/scripts/command-metadata.json +94 -0
  229. package/template/.opencode/skills/impeccable/scripts/critique-storage.mjs +242 -0
  230. package/template/.opencode/skills/impeccable/scripts/design-parser.mjs +820 -0
  231. package/template/.opencode/skills/impeccable/scripts/detect-csp.mjs +198 -0
  232. package/template/.opencode/skills/impeccable/scripts/detect.mjs +21 -0
  233. package/template/.opencode/skills/impeccable/scripts/impeccable-paths.mjs +110 -0
  234. package/template/.opencode/skills/impeccable/scripts/is-generated.mjs +69 -0
  235. package/template/.opencode/skills/impeccable/scripts/live-accept.mjs +595 -0
  236. package/template/.opencode/skills/impeccable/scripts/live-browser-session.js +123 -0
  237. package/template/.opencode/skills/impeccable/scripts/live-browser.js +4860 -0
  238. package/template/.opencode/skills/impeccable/scripts/live-complete.mjs +75 -0
  239. package/template/.opencode/skills/impeccable/scripts/live-completion.mjs +18 -0
  240. package/template/.opencode/skills/impeccable/scripts/live-inject.mjs +446 -0
  241. package/template/.opencode/skills/impeccable/scripts/live-poll.mjs +200 -0
  242. package/template/.opencode/skills/impeccable/scripts/live-resume.mjs +48 -0
  243. package/template/.opencode/skills/impeccable/scripts/live-server.mjs +838 -0
  244. package/template/.opencode/skills/impeccable/scripts/live-session-store.mjs +254 -0
  245. package/template/.opencode/skills/impeccable/scripts/live-status.mjs +47 -0
  246. package/template/.opencode/skills/impeccable/scripts/live-wrap.mjs +632 -0
  247. package/template/.opencode/skills/impeccable/scripts/live.mjs +247 -0
  248. package/template/.opencode/skills/impeccable/scripts/load-context.mjs +141 -0
  249. package/template/.opencode/skills/impeccable/scripts/modern-screenshot.umd.js +14 -0
  250. package/template/.opencode/skills/impeccable/scripts/pin.mjs +214 -0
  251. package/template/.opencode/skills/iterative-retrieval/SKILL.md +202 -0
  252. package/template/.opencode/skills/java-coding-standards/SKILL.md +138 -0
  253. package/template/.opencode/skills/jetpack-compose/.skillfish.json +10 -0
  254. package/template/.opencode/skills/jetpack-compose/SKILL.md +420 -0
  255. package/template/.opencode/skills/jpa-patterns/SKILL.md +141 -0
  256. package/template/.opencode/skills/nutrient-document-processing/SKILL.md +165 -0
  257. package/template/.opencode/skills/nuxt-ui/SKILL.md +334 -0
  258. package/template/.opencode/skills/nuxt-ui/references/components.md +377 -0
  259. package/template/.opencode/skills/nuxt-ui/references/composables.md +127 -0
  260. package/template/.opencode/skills/nuxt-ui/references/layouts/chat.md +266 -0
  261. package/template/.opencode/skills/nuxt-ui/references/layouts/dashboard.md +220 -0
  262. package/template/.opencode/skills/nuxt-ui/references/layouts/docs.md +141 -0
  263. package/template/.opencode/skills/nuxt-ui/references/layouts/editor.md +168 -0
  264. package/template/.opencode/skills/nuxt-ui/references/layouts/page.md +260 -0
  265. package/template/.opencode/skills/nuxt-ui/references/theming.md +427 -0
  266. package/template/.opencode/skills/postgres-patterns/SKILL.md +146 -0
  267. package/template/.opencode/skills/project-guidelines-example/SKILL.md +345 -0
  268. package/template/.opencode/skills/python-patterns/SKILL.md +749 -0
  269. package/template/.opencode/skills/python-testing/SKILL.md +815 -0
  270. package/template/.opencode/skills/security-review/SKILL.md +494 -0
  271. package/template/.opencode/skills/security-review/cloud-infrastructure-security.md +361 -0
  272. package/template/.opencode/skills/shadcn-ui/README.md +248 -0
  273. package/template/.opencode/skills/shadcn-ui/SKILL.md +326 -0
  274. package/template/.opencode/skills/shadcn-ui/examples/auth-layout.tsx +177 -0
  275. package/template/.opencode/skills/shadcn-ui/examples/data-table.tsx +313 -0
  276. package/template/.opencode/skills/shadcn-ui/examples/form-pattern.tsx +177 -0
  277. package/template/.opencode/skills/shadcn-ui/resources/component-catalog.md +481 -0
  278. package/template/.opencode/skills/shadcn-ui/resources/customization-guide.md +516 -0
  279. package/template/.opencode/skills/shadcn-ui/resources/migration-guide.md +463 -0
  280. package/template/.opencode/skills/shadcn-ui/resources/setup-guide.md +412 -0
  281. package/template/.opencode/skills/shadcn-ui/scripts/verify-setup.sh +134 -0
  282. package/template/.opencode/skills/springboot-patterns/SKILL.md +304 -0
  283. package/template/.opencode/skills/springboot-security/SKILL.md +119 -0
  284. package/template/.opencode/skills/springboot-tdd/SKILL.md +157 -0
  285. package/template/.opencode/skills/springboot-verification/SKILL.md +100 -0
  286. package/template/.opencode/skills/strategic-compact/SKILL.md +63 -0
  287. package/template/.opencode/skills/strategic-compact/suggest-compact.sh +52 -0
  288. package/template/.opencode/skills/tdd-workflow/SKILL.md +409 -0
  289. package/template/.opencode/skills/vercel-composition-patterns/AGENTS.md +946 -0
  290. package/template/.opencode/skills/vercel-composition-patterns/SKILL.md +89 -0
  291. package/template/.opencode/skills/vercel-composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
  292. package/template/.opencode/skills/vercel-composition-patterns/rules/architecture-compound-components.md +112 -0
  293. package/template/.opencode/skills/vercel-composition-patterns/rules/patterns-children-over-render-props.md +87 -0
  294. package/template/.opencode/skills/vercel-composition-patterns/rules/patterns-explicit-variants.md +100 -0
  295. package/template/.opencode/skills/vercel-composition-patterns/rules/react19-no-forwardref.md +42 -0
  296. package/template/.opencode/skills/vercel-composition-patterns/rules/state-context-interface.md +191 -0
  297. package/template/.opencode/skills/vercel-composition-patterns/rules/state-decouple-implementation.md +113 -0
  298. package/template/.opencode/skills/vercel-composition-patterns/rules/state-lift-state.md +125 -0
  299. package/template/.opencode/skills/vercel-react-best-practices/AGENTS.md +2934 -0
  300. package/template/.opencode/skills/vercel-react-best-practices/SKILL.md +136 -0
  301. package/template/.opencode/skills/vercel-react-best-practices/rules/advanced-event-handler-refs.md +55 -0
  302. package/template/.opencode/skills/vercel-react-best-practices/rules/advanced-init-once.md +42 -0
  303. package/template/.opencode/skills/vercel-react-best-practices/rules/advanced-use-latest.md +39 -0
  304. package/template/.opencode/skills/vercel-react-best-practices/rules/async-api-routes.md +38 -0
  305. package/template/.opencode/skills/vercel-react-best-practices/rules/async-defer-await.md +80 -0
  306. package/template/.opencode/skills/vercel-react-best-practices/rules/async-dependencies.md +51 -0
  307. package/template/.opencode/skills/vercel-react-best-practices/rules/async-parallel.md +28 -0
  308. package/template/.opencode/skills/vercel-react-best-practices/rules/async-suspense-boundaries.md +99 -0
  309. package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-barrel-imports.md +59 -0
  310. package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-conditional.md +31 -0
  311. package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-defer-third-party.md +49 -0
  312. package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-dynamic-imports.md +35 -0
  313. package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-preload.md +50 -0
  314. package/template/.opencode/skills/vercel-react-best-practices/rules/client-event-listeners.md +74 -0
  315. package/template/.opencode/skills/vercel-react-best-practices/rules/client-localstorage-schema.md +71 -0
  316. package/template/.opencode/skills/vercel-react-best-practices/rules/client-passive-event-listeners.md +48 -0
  317. package/template/.opencode/skills/vercel-react-best-practices/rules/client-swr-dedup.md +56 -0
  318. package/template/.opencode/skills/vercel-react-best-practices/rules/js-batch-dom-css.md +107 -0
  319. package/template/.opencode/skills/vercel-react-best-practices/rules/js-cache-function-results.md +80 -0
  320. package/template/.opencode/skills/vercel-react-best-practices/rules/js-cache-property-access.md +28 -0
  321. package/template/.opencode/skills/vercel-react-best-practices/rules/js-cache-storage.md +70 -0
  322. package/template/.opencode/skills/vercel-react-best-practices/rules/js-combine-iterations.md +32 -0
  323. package/template/.opencode/skills/vercel-react-best-practices/rules/js-early-exit.md +50 -0
  324. package/template/.opencode/skills/vercel-react-best-practices/rules/js-hoist-regexp.md +45 -0
  325. package/template/.opencode/skills/vercel-react-best-practices/rules/js-index-maps.md +37 -0
  326. package/template/.opencode/skills/vercel-react-best-practices/rules/js-length-check-first.md +49 -0
  327. package/template/.opencode/skills/vercel-react-best-practices/rules/js-min-max-loop.md +82 -0
  328. package/template/.opencode/skills/vercel-react-best-practices/rules/js-set-map-lookups.md +24 -0
  329. package/template/.opencode/skills/vercel-react-best-practices/rules/js-tosorted-immutable.md +57 -0
  330. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-activity.md +26 -0
  331. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
  332. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-conditional-render.md +40 -0
  333. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-content-visibility.md +38 -0
  334. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-hoist-jsx.md +46 -0
  335. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
  336. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +30 -0
  337. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-svg-precision.md +28 -0
  338. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-usetransition-loading.md +75 -0
  339. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-defer-reads.md +39 -0
  340. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-dependencies.md +45 -0
  341. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
  342. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-derived-state.md +29 -0
  343. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-functional-setstate.md +74 -0
  344. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-lazy-state-init.md +58 -0
  345. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +38 -0
  346. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-memo.md +44 -0
  347. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
  348. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
  349. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-transitions.md +40 -0
  350. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
  351. package/template/.opencode/skills/vercel-react-best-practices/rules/server-after-nonblocking.md +73 -0
  352. package/template/.opencode/skills/vercel-react-best-practices/rules/server-auth-actions.md +96 -0
  353. package/template/.opencode/skills/vercel-react-best-practices/rules/server-cache-lru.md +41 -0
  354. package/template/.opencode/skills/vercel-react-best-practices/rules/server-cache-react.md +76 -0
  355. package/template/.opencode/skills/vercel-react-best-practices/rules/server-dedup-props.md +65 -0
  356. package/template/.opencode/skills/vercel-react-best-practices/rules/server-parallel-fetching.md +83 -0
  357. package/template/.opencode/skills/vercel-react-best-practices/rules/server-serialization.md +38 -0
  358. package/template/.opencode/skills/verification-loop/SKILL.md +120 -0
  359. package/template/.opencode/skills/web-design-guidelines/SKILL.md +39 -0
  360. package/template/AGENTS.md +32 -0
  361. package/template/opencode.json +354 -0
@@ -0,0 +1,266 @@
1
+ # Chat Layout
2
+
3
+ Build AI chat interfaces with message streams, reasoning, tool calling, and Vercel AI SDK integration.
4
+
5
+ ## Component tree
6
+
7
+ ```
8
+ UApp
9
+ └── NuxtLayout (dashboard)
10
+ └── UDashboardGroup
11
+ ├── UDashboardSidebar (conversations)
12
+ └── NuxtPage
13
+ └── UDashboardPanel
14
+ ├── #header → UDashboardNavbar
15
+ ├── #body → UContainer → UChatMessages
16
+ │ ├── #content → UChatReasoning, UChatTool, MDC
17
+ │ └── #indicator (loading)
18
+ └── #footer → UContainer → UChatPrompt
19
+ └── UChatPromptSubmit
20
+ ```
21
+
22
+ ## Setup
23
+
24
+ ### Install AI SDK
25
+
26
+ ```bash
27
+ pnpm add ai @ai-sdk/gateway @ai-sdk/vue
28
+ ```
29
+
30
+ ### Server endpoint
31
+
32
+ ```ts [server/api/chat.post.ts]
33
+ import { streamText, convertToModelMessages } from 'ai'
34
+ import { gateway } from '@ai-sdk/gateway'
35
+
36
+ export default defineEventHandler(async (event) => {
37
+ const { messages } = await readBody(event)
38
+
39
+ return streamText({
40
+ model: gateway('anthropic/claude-sonnet-4.6'),
41
+ system: 'You are a helpful assistant.',
42
+ messages: await convertToModelMessages(messages)
43
+ }).toUIMessageStreamResponse()
44
+ })
45
+ ```
46
+
47
+ ## Full page chat
48
+
49
+ ```vue [pages/chat/[id].vue]
50
+ <script setup lang="ts">
51
+ import { isReasoningUIPart, isTextUIPart, isToolUIPart, getToolName } from 'ai'
52
+ import { Chat } from '@ai-sdk/vue'
53
+ import { isReasoningStreaming, isToolStreaming } from '@nuxt/ui/utils/ai'
54
+
55
+ definePageMeta({ layout: 'dashboard' })
56
+
57
+ const input = ref('')
58
+
59
+ const chat = new Chat({
60
+ onError(error) {
61
+ console.error(error)
62
+ }
63
+ })
64
+
65
+ function onSubmit() {
66
+ if (!input.value.trim()) return
67
+
68
+ chat.sendMessage({ text: input.value })
69
+
70
+ input.value = ''
71
+ }
72
+ </script>
73
+
74
+ <template>
75
+ <UDashboardPanel>
76
+ <template #header>
77
+ <UDashboardNavbar title="Chat" />
78
+ </template>
79
+
80
+ <template #body>
81
+ <UContainer>
82
+ <UChatMessages :messages="chat.messages" :status="chat.status">
83
+ <template #content="{ message }">
84
+ <template v-for="(part, index) in message.parts" :key="`${message.id}-${part.type}-${index}`">
85
+ <UChatReasoning
86
+ v-if="isReasoningUIPart(part)"
87
+ :text="part.text"
88
+ :streaming="isReasoningStreaming(message, index, chat)"
89
+ >
90
+ <MDC
91
+ :value="part.text"
92
+ :cache-key="`reasoning-${message.id}-${index}`"
93
+ class="*:first:mt-0 *:last:mb-0"
94
+ />
95
+ </UChatReasoning>
96
+
97
+ <UChatTool
98
+ v-else-if="isToolUIPart(part)"
99
+ :text="getToolName(part)"
100
+ :streaming="isToolStreaming(part)"
101
+ />
102
+
103
+ <MDC
104
+ v-else-if="isTextUIPart(part)"
105
+ :value="part.text"
106
+ :cache-key="`${message.id}-${index}`"
107
+ class="*:first:mt-0 *:last:mb-0"
108
+ />
109
+ </template>
110
+ </template>
111
+ </UChatMessages>
112
+ </UContainer>
113
+ </template>
114
+
115
+ <template #footer>
116
+ <UContainer class="pb-4 sm:pb-6">
117
+ <UChatPrompt v-model="input" :error="chat.error" @submit="onSubmit">
118
+ <UChatPromptSubmit :status="chat.status" @stop="chat.stop()" @reload="chat.regenerate()" />
119
+ </UChatPrompt>
120
+ </UContainer>
121
+ </template>
122
+ </UDashboardPanel>
123
+ </template>
124
+ ```
125
+
126
+ ## Key components
127
+
128
+ ### ChatMessages
129
+
130
+ Scrollable message list with auto-scroll and loading indicator.
131
+
132
+ | Prop | Description |
133
+ |---|---|
134
+ | `messages` | Array of AI SDK messages |
135
+ | `status` | `'submitted'`, `'streaming'`, `'ready'`, `'error'` |
136
+
137
+ Slots: `#content` (receives `{ message }`), `#actions` (per-message), `#indicator` (loading)
138
+
139
+ ### ChatMessage
140
+
141
+ Individual message bubble with avatar, actions, and slots.
142
+
143
+ | Prop | Description |
144
+ |---|---|
145
+ | `message` | AI SDK UIMessage object |
146
+ | `side` | `'left'` (default), `'right'` |
147
+
148
+ ### ChatReasoning
149
+
150
+ Collapsible block for AI reasoning / thinking process. Auto-opens during streaming, auto-closes when done.
151
+
152
+ | Prop | Description |
153
+ |---|---|
154
+ | `text` | Reasoning text (displayed inside collapsible content) |
155
+ | `streaming` | Whether reasoning is actively streaming |
156
+ | `open` | Controlled open state |
157
+
158
+ Use `isReasoningStreaming(message, index, chat)` from `@nuxt/ui/utils/ai` to determine streaming state.
159
+
160
+ ### ChatTool
161
+
162
+ Collapsible block for AI tool invocation status.
163
+
164
+ | Prop | Description |
165
+ |---|---|
166
+ | `text` | Tool status text (displayed in trigger) |
167
+ | `icon` | Icon name |
168
+ | `loading` | Show loading spinner on icon |
169
+ | `streaming` | Whether tool is actively running |
170
+ | `suffix` | Secondary text after label |
171
+ | `variant` | `'inline'` (default), `'card'` |
172
+ | `chevron` | `'trailing'` (default), `'leading'` |
173
+
174
+ Use `isToolStreaming(part)` from `@nuxt/ui/utils/ai` to determine if a tool is still running.
175
+
176
+ ### ChatShimmer
177
+
178
+ Text shimmer animation for streaming states. Automatically used by ChatReasoning and ChatTool when streaming.
179
+
180
+ ### ChatPrompt
181
+
182
+ Enhanced textarea form for prompts. Accepts all Textarea props.
183
+
184
+ | Prop | Description |
185
+ |---|---|
186
+ | `v-model` | Input text binding |
187
+ | `error` | Error from chat instance |
188
+ | `variant` | `'outline'` (default), `'subtle'`, `'soft'`, `'ghost'`, `'none'` |
189
+
190
+ Slots: `#default` (submit button), `#footer` (below input, e.g. model selector)
191
+
192
+ ### ChatPromptSubmit
193
+
194
+ Submit button with automatic status handling (send/stop/reload).
195
+
196
+ ### ChatPalette
197
+
198
+ Layout wrapper for chat inside overlays (Modal, Slideover, Drawer).
199
+
200
+ ## Chat in a modal
201
+
202
+ ```vue
203
+ <UModal v-model:open="isOpen">
204
+ <template #content>
205
+ <UChatPalette>
206
+ <UChatMessages :messages="chat.messages" :status="chat.status" />
207
+
208
+ <template #prompt>
209
+ <UChatPrompt v-model="input" @submit="onSubmit">
210
+ <UChatPromptSubmit :status="chat.status" />
211
+ </UChatPrompt>
212
+ </template>
213
+ </UChatPalette>
214
+ </template>
215
+ </UModal>
216
+ ```
217
+
218
+ ## With model selector
219
+
220
+ ```vue
221
+ <script setup lang="ts">
222
+ const input = ref('')
223
+ const model = ref('claude-opus-4.6')
224
+ const models = [
225
+ { label: 'Claude Opus 4.6', value: 'claude-opus-4.6', icon: 'i-simple-icons-anthropic' },
226
+ { label: 'Gemini 3 Pro', value: 'gemini-3-pro', icon: 'i-simple-icons-googlegemini' },
227
+ { label: 'GPT-5', value: 'gpt-5', icon: 'i-simple-icons-openai' }
228
+ ]
229
+ </script>
230
+
231
+ <template>
232
+ <UChatPrompt v-model="input" @submit="onSubmit">
233
+ <UChatPromptSubmit :status="chat.status" />
234
+
235
+ <template #footer>
236
+ <USelect
237
+ v-model="model"
238
+ :icon="models.find(m => m.value === model)?.icon"
239
+ placeholder="Select a model"
240
+ variant="ghost"
241
+ :items="models"
242
+ />
243
+ </template>
244
+ </UChatPrompt>
245
+ </template>
246
+ ```
247
+
248
+ ## Conversation sidebar
249
+
250
+ ```vue [layouts/dashboard.vue]
251
+ <template>
252
+ <UDashboardGroup>
253
+ <UDashboardSidebar collapsible resizable>
254
+ <template #header>
255
+ <UButton icon="i-lucide-plus" label="New chat" block />
256
+ </template>
257
+
258
+ <template #default>
259
+ <UNavigationMenu :items="conversations" orientation="vertical" />
260
+ </template>
261
+ </UDashboardSidebar>
262
+
263
+ <slot />
264
+ </UDashboardGroup>
265
+ </template>
266
+ ```
@@ -0,0 +1,220 @@
1
+ # Dashboard Layout
2
+
3
+ Build admin interfaces with resizable sidebars, multi-panel layouts, and toolbars.
4
+
5
+ ## Component tree
6
+
7
+ ```
8
+ UApp
9
+ └── NuxtLayout (dashboard)
10
+ └── UDashboardGroup
11
+ ├── UDashboardSidebar
12
+ │ ├── #header (logo, search button)
13
+ │ ├── #default (navigation) — receives { collapsed } slot prop
14
+ │ └── #footer (user menu)
15
+ └── NuxtPage
16
+ └── UDashboardPanel
17
+ ├── #header → UDashboardNavbar + UDashboardToolbar
18
+ ├── #body (scrollable content)
19
+ └── #footer (optional)
20
+ ```
21
+
22
+ ## Layout
23
+
24
+ ```vue [layouts/dashboard.vue]
25
+ <script setup lang="ts">
26
+ import type { NavigationMenuItem } from '@nuxt/ui'
27
+
28
+ const items = computed<NavigationMenuItem[]>(() => [{
29
+ label: 'Home',
30
+ icon: 'i-lucide-house',
31
+ to: '/dashboard'
32
+ }, {
33
+ label: 'Inbox',
34
+ icon: 'i-lucide-inbox',
35
+ to: '/dashboard/inbox'
36
+ }, {
37
+ label: 'Users',
38
+ icon: 'i-lucide-users',
39
+ to: '/dashboard/users'
40
+ }, {
41
+ label: 'Settings',
42
+ icon: 'i-lucide-settings',
43
+ to: '/dashboard/settings'
44
+ }])
45
+ </script>
46
+
47
+ <template>
48
+ <UDashboardGroup>
49
+ <UDashboardSidebar collapsible resizable>
50
+ <template #header="{ collapsed }">
51
+ <UDashboardSearchButton :collapsed="collapsed" />
52
+ </template>
53
+
54
+ <template #default="{ collapsed }">
55
+ <UNavigationMenu
56
+ :items="items"
57
+ orientation="vertical"
58
+ :ui="{ link: collapsed ? 'justify-center' : undefined }"
59
+ />
60
+ </template>
61
+
62
+ <template #footer="{ collapsed }">
63
+ <UButton
64
+ :icon="collapsed ? 'i-lucide-log-out' : undefined"
65
+ :label="collapsed ? undefined : 'Sign out'"
66
+ color="neutral"
67
+ variant="ghost"
68
+ block
69
+ />
70
+ </template>
71
+ </UDashboardSidebar>
72
+
73
+ <slot />
74
+ </UDashboardGroup>
75
+ </template>
76
+ ```
77
+
78
+ ## Page
79
+
80
+ ```vue [pages/dashboard/index.vue]
81
+ <script setup lang="ts">
82
+ definePageMeta({ layout: 'dashboard' })
83
+ </script>
84
+
85
+ <template>
86
+ <UDashboardPanel>
87
+ <template #header>
88
+ <UDashboardNavbar title="Home">
89
+ <template #right>
90
+ <UButton icon="i-lucide-plus" label="New" />
91
+ </template>
92
+ </UDashboardNavbar>
93
+ </template>
94
+
95
+ <template #body>
96
+ <!-- Page content -->
97
+ </template>
98
+ </UDashboardPanel>
99
+ </template>
100
+ ```
101
+
102
+ ## Key components
103
+
104
+ ### DashboardGroup
105
+
106
+ Root layout wrapper. Manages sidebar state and persistence.
107
+
108
+ | Prop | Default | Description |
109
+ |---|---|---|
110
+ | `storage` | `'cookie'` | State persistence: `'cookie'`, `'localStorage'`, `false` |
111
+ | `storage-key` | `'dashboard'` | Storage key name |
112
+ | `unit` | `'percentages'` | Size unit: `'percentages'` or `'pixels'` |
113
+
114
+ ### DashboardSidebar
115
+
116
+ Resizable, collapsible sidebar. Must be inside `DashboardGroup`.
117
+
118
+ | Prop | Default | Description |
119
+ |---|---|---|
120
+ | `resizable` | `false` | Enable resize by dragging |
121
+ | `collapsible` | `false` | Enable collapse when dragged to edge |
122
+ | `side` | `'left'` | `'left'` or `'right'` |
123
+ | `mode` | `'slideover'` | Mobile menu mode: `'modal'`, `'slideover'`, `'drawer'` |
124
+
125
+ Slots receive `{ collapsed }` prop. Control state: `v-model:collapsed`, `v-model:open` (mobile).
126
+
127
+ ### DashboardPanel
128
+
129
+ Content panel with `#header`, `#body` (scrollable), `#footer`, and `#default` (raw) slots.
130
+
131
+ | Prop | Default | Description |
132
+ |---|---|---|
133
+ | `id` | `—` | Unique ID (required for multi-panel) |
134
+ | `resizable` | `false` | Enable resize by dragging |
135
+
136
+ ### DashboardNavbar / DashboardToolbar
137
+
138
+ Navbar has `#left`, `#default`, `#right` slots and a `title` prop. Toolbar has the same slots for filters/actions below the navbar.
139
+
140
+ ## Multi-panel (list-detail)
141
+
142
+ ```vue [pages/dashboard/inbox.vue]
143
+ <script setup lang="ts">
144
+ definePageMeta({ layout: 'dashboard' })
145
+ </script>
146
+
147
+ <template>
148
+ <UDashboardPanel id="inbox-list" resizable>
149
+ <template #header>
150
+ <UDashboardNavbar title="Inbox" />
151
+ </template>
152
+ <template #body>
153
+ <!-- Email list -->
154
+ </template>
155
+ </UDashboardPanel>
156
+
157
+ <UDashboardPanel id="inbox-detail" class="hidden lg:flex">
158
+ <template #header>
159
+ <UDashboardNavbar title="Message" />
160
+ </template>
161
+ <template #body>
162
+ <!-- Email content -->
163
+ </template>
164
+ </UDashboardPanel>
165
+ </template>
166
+ ```
167
+
168
+ ## With toolbar
169
+
170
+ ```vue
171
+ <UDashboardPanel>
172
+ <template #header>
173
+ <UDashboardNavbar title="Users" />
174
+
175
+ <UDashboardToolbar>
176
+ <template #left>
177
+ <UInput icon="i-lucide-search" placeholder="Search..." />
178
+ </template>
179
+ <template #right>
180
+ <USelect :items="['All', 'Active', 'Inactive']" />
181
+ </template>
182
+ </UDashboardToolbar>
183
+ </template>
184
+ </UDashboardPanel>
185
+ ```
186
+
187
+ ## With search
188
+
189
+ ```vue [layouts/dashboard.vue]
190
+ <template>
191
+ <UDashboardGroup>
192
+ <UDashboardSidebar>
193
+ <template #header>
194
+ <UDashboardSearchButton />
195
+ </template>
196
+ <!-- ... -->
197
+ </UDashboardSidebar>
198
+
199
+ <slot />
200
+
201
+ <UDashboardSearch :groups="searchGroups" />
202
+ </UDashboardGroup>
203
+ </template>
204
+ ```
205
+
206
+ ## Right sidebar
207
+
208
+ ```vue
209
+ <UDashboardGroup>
210
+ <UDashboardSidebar collapsible resizable>
211
+ <!-- Left sidebar -->
212
+ </UDashboardSidebar>
213
+
214
+ <slot />
215
+
216
+ <UDashboardSidebar side="right" resizable>
217
+ <!-- Right sidebar -->
218
+ </UDashboardSidebar>
219
+ </UDashboardGroup>
220
+ ```
@@ -0,0 +1,141 @@
1
+ # Docs Layout
2
+
3
+ Build documentation sites with sidebar navigation, table of contents, and surround links.
4
+
5
+ > Requires `@nuxt/content` module for navigation, search, and TOC.
6
+
7
+ ## Component tree
8
+
9
+ ```
10
+ UApp
11
+ ├── UHeader
12
+ ├── UMain
13
+ │ └── NuxtLayout (docs)
14
+ │ └── UPage
15
+ │ ├── #left → UPageAside → UContentNavigation
16
+ │ └── NuxtPage
17
+ │ ├── UPageHeader
18
+ │ ├── UPageBody → ContentRenderer + UContentSurround
19
+ │ └── #right → UContentToc
20
+ └── UFooter
21
+ ```
22
+
23
+ ## App shell
24
+
25
+ ```vue [app.vue]
26
+ <script setup lang="ts">
27
+ import type { NavigationMenuItem } from '@nuxt/ui'
28
+
29
+ const route = useRoute()
30
+
31
+ const { data: navigation } = await useAsyncData('navigation', () => queryCollectionNavigation('docs'))
32
+
33
+ provide('navigation', navigation)
34
+
35
+ const items = computed<NavigationMenuItem[]>(() => [{
36
+ label: 'Docs',
37
+ to: '/docs/getting-started',
38
+ active: route.path.startsWith('/docs')
39
+ }])
40
+ </script>
41
+
42
+ <template>
43
+ <UApp>
44
+ <UHeader>
45
+ <template #title>
46
+ <Logo class="h-6 w-auto" />
47
+ </template>
48
+
49
+ <UNavigationMenu :items="items" />
50
+
51
+ <template #right>
52
+ <UContentSearchButton />
53
+ <UColorModeButton />
54
+ </template>
55
+ </UHeader>
56
+
57
+ <UMain>
58
+ <NuxtLayout>
59
+ <NuxtPage />
60
+ </NuxtLayout>
61
+ </UMain>
62
+
63
+ <UFooter />
64
+
65
+ <UContentSearch :navigation="navigation" />
66
+ </UApp>
67
+ </template>
68
+ ```
69
+
70
+ ## Layout
71
+
72
+ ```vue [layouts/docs.vue]
73
+ <script setup lang="ts">
74
+ import type { ContentNavigationItem } from '@nuxt/content'
75
+
76
+ const navigation = inject<Ref<ContentNavigationItem[]>>('navigation')
77
+ </script>
78
+
79
+ <template>
80
+ <UPage>
81
+ <template #left>
82
+ <UPageAside>
83
+ <UContentNavigation :navigation="navigation" />
84
+ </UPageAside>
85
+ </template>
86
+
87
+ <slot />
88
+ </UPage>
89
+ </template>
90
+ ```
91
+
92
+ ## Page
93
+
94
+ ```vue [pages/docs/[...slug].vue]
95
+ <script setup lang="ts">
96
+ const route = useRoute()
97
+
98
+ definePageMeta({ layout: 'docs' })
99
+
100
+ const { data: page } = await useAsyncData(route.path, () => {
101
+ return queryCollection('docs').path(route.path).first()
102
+ })
103
+
104
+ const { data: surround } = await useAsyncData(`${route.path}-surround`, () => {
105
+ return queryCollectionItemSurroundings('docs', route.path)
106
+ })
107
+ </script>
108
+
109
+ <template>
110
+ <UPage>
111
+ <UPageHeader :title="page.title" :description="page.description" />
112
+
113
+ <UPageBody>
114
+ <ContentRenderer :value="page" />
115
+
116
+ <USeparator />
117
+
118
+ <UContentSurround :surround="surround" />
119
+ </UPageBody>
120
+
121
+ <template #right>
122
+ <UContentToc :links="page.body.toc.links" />
123
+ </template>
124
+ </UPage>
125
+ </template>
126
+ ```
127
+
128
+ > The outer `UPage` in the layout handles the left sidebar. The inner `UPage` in the page handles the right sidebar. They nest correctly.
129
+
130
+ ## Key components
131
+
132
+ - `UPage` — Multi-column grid layout with `#left`, `#default`, `#right` slots
133
+ - `UPageAside` — Sticky sidebar wrapper (visible from `lg` breakpoint)
134
+ - `UPageHeader` — Page title and description
135
+ - `UPageBody` — Main content area
136
+ - `UContentNavigation` — Sidebar navigation tree
137
+ - `UContentToc` — Table of contents
138
+ - `UContentSurround` — Prev/next links
139
+ - `UContentSearch` / `UContentSearchButton` — Search command palette
140
+ - `UPageAnchors` — Simpler alternative to full TOC
141
+ - `UPageLinks` — Related resource links