chore: initial commit

refine docs experience and refresh site branding

add mobile docs menu hierarchy

Author: hirotaka

.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: ci
+on: push
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [24]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+      - name: Install node
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node }}
+          cache: pnpm
+      - name: Install dependencies
+        run: pnpm install
+      - name: Lint
+        run: pnpm run lint
+      - name: Typecheck
+        run: pnpm run typecheck

.gitignore

@@ -0,0 +1,29 @@
+# Nuxt dev/build outputs
+.output
+.data
+.nuxt
+.nitro
+.cache
+dist
+
+# Node dependencies
+node_modules
+
+# Logs
+logs
+*.log
+
+# Misc
+.DS_Store
+.fleet
+.idea
+
+# Local env files
+.env
+.env.*
+!.env.example
+
+.dmux/worktrees/task-response/.data
+.dmux/worktrees/task-request/.data
+.dmux/worktrees/task-15-3/.data
+.dmux/worktrees/task-15-5/.data

AGENTS.md

@@ -0,0 +1,52 @@
+# AGENTS.md
+
+## Project overview
+
+Nuxt 4 documentation site with a built-in shadcn-vue component registry for distributing custom blocks.
+
+## Commands
+
+- `pnpm dev` — dev server
+- `pnpm lint` — ESLint (`@nuxt/eslint`-based, stylistic enabled: double quotes, semi)
+- `pnpm lint:fix` — auto-fix
+- `pnpm typecheck` — `nuxt typecheck`
+- `pnpm registry:build` — generate registry JSON files into `public/r/`
+
+CI order: **lint → typecheck** (no tests)
+
+## Architecture
+
+- **Nuxt 4 compat mode** (`future.compatibilityVersion: 4`) — app code lives under `app/`
+- `app/components/ui/` — shadcn-vue UI primitives (`shadcn-nuxt` module, no prefix)
+- `app/components/content/` — global MDC components (`pathPrefix: false`)
+- `app/components/_internal/`, `app/components/examples/` — excluded from Nuxt auto-imports
+- `app/registry/blocks/` — distributable components; each block = directory with `index.ts` + `.vue`
+- `content/docs/` — Markdown docs (`@nuxt/content` v3, D1 database)
+- `public/r/` — generated output from `registry:build` (should be gitignored)
+
+## Registry build
+
+`pnpm registry:build` runs `scripts/registry-build.ts`:
+1. `shadcn-vue-registry` generates registry.json from `app/registry/`
+2. `shadcn-vue build` outputs per-item JSON to `public/r/*.json`
+3. Intermediate file `app/registry/registry.json` is auto-deleted
+
+Config: `registry.config.ts` and `components.json` `registries` field.
+
+## Style conventions
+
+- ESLint stylistic: **double quotes**, **semicolons**
+- Tailwind v4 via `@tailwindcss/vite` plugin — no `tailwind.config` file
+- shadcn-vue style: `new-york`, baseColor: `neutral`, CSS variables enabled
+- Icons: `lucide-vue-next`
+
+## Content
+
+- `content.config.ts` defines the docs collection with `category` field: `element | chat | overview`
+- `@nuxt/content` v3 with D1 database (`content.database.type: "d1"`)
+- Markdown highlight disabled; `nuxt-shiki` module handles syntax highlighting instead
+
+## Infrastructure
+
+- **NuxtHub** (`@nuxthub/core`) — Cloudflare D1/SQLite bindings
+- `hub.db: "sqlite"` — uses SQLite for local development

README.md

@@ -0,0 +1,58 @@
+# shadcn-nuxt-ui/docs
+
+Open-source templates and reusable components for Nuxt, built for the shadcn-vue community.
+
+This project aims to make shadcn-vue easier to use in Nuxt by providing:
+
+- practical templates you can start from,
+- reusable components you can install independently,
+- documentation that connects both paths clearly.
+
+It is intended as an additional option for Nuxt developers, not a replacement for other UI ecosystems.
+
+## What this repository includes
+
+- **Docs site** (Nuxt 4 + Nuxt Content)
+- **shadcn-vue registry output** under `public/r/*.json`
+- **Template and component documentation** under `content/docs`
+
+## Use the registry
+
+Install an item with the shadcn-vue CLI:
+
+```bash
+npx shadcn-vue@latest add "https://shadcn-nuxt-ui.stackhacker.io/r/lucide-icon.json"
+```
+
+## Local development
+
+Install dependencies:
+
+```bash
+pnpm install
+```
+
+Start the docs site:
+
+```bash
+pnpm dev
+```
+
+## Quality checks
+
+```bash
+pnpm lint
+pnpm typecheck
+```
+
+## Build registry files
+
+```bash
+pnpm registry:build
+```
+
+This command generates distributable registry JSON files in `public/r/`.
+
+## Related repository
+
+- Chat template: `https://github.com/shadcn-nuxt-ui/chat`

app/app.vue

@@ -0,0 +1,15 @@
+<script lang="ts" setup>
+import { ConfigProvider, TooltipProvider } from "reka-ui";
+</script>
+
+<template>
+  <SiteBody>
+    <ConfigProvider>
+      <TooltipProvider>
+        <NuxtLayout>
+          <NuxtPage />
+        </NuxtLayout>
+      </TooltipProvider>
+    </ConfigProvider>
+  </SiteBody>
+</template>