Package Exports
- @nuxtjs/sanity
- @nuxtjs/sanity/package.json
- @nuxtjs/sanity/runtime/client.d.ts
- @nuxtjs/sanity/runtime/client.mjs
- @nuxtjs/sanity/runtime/components/sanity-content.d.ts
- @nuxtjs/sanity/runtime/components/sanity-content.mjs
- @nuxtjs/sanity/runtime/components/sanity-file.d.ts
- @nuxtjs/sanity/runtime/components/sanity-file.mjs
- @nuxtjs/sanity/runtime/components/sanity-image.d.ts
- @nuxtjs/sanity/runtime/components/sanity-image.mjs
- @nuxtjs/sanity/runtime/composables.d.ts
- @nuxtjs/sanity/runtime/composables.mjs
- @nuxtjs/sanity/runtime/groq.d.ts
- @nuxtjs/sanity/runtime/groq.mjs
- @nuxtjs/sanity/runtime/nitro-imports.d.ts
- @nuxtjs/sanity/runtime/nitro-imports.mjs
- @nuxtjs/sanity/runtime/plugin.d.ts
- @nuxtjs/sanity/runtime/plugin.mjs
Readme
Nuxt Sanity
Features
- Just bring your sanity.json - no additional configuration required
- Ultra-lightweight Sanity client
- Zero-config image/file components + portable text renderer
- Supports GROQ syntax highlighting
- Nuxt 3 and Nuxt Bridge support
Quick setup
- Add
@nuxtjs/sanity
dependency to your project
yarn add @nuxtjs/sanity # or npm install @nuxtjs/sanity
- Add
@nuxtjs/sanity
to themodules
section ofnuxt.config.ts
{
modules: [
'@nuxtjs/sanity',
],
sanity: {
// module options
}
}
Note: For Nuxt 2 support without Bridge, install @nuxtjs/sanity@0.10.0
and follow the instructions at https://v0.sanity.nuxtjs.org.
Development
- Clone this repository
- Install dependencies using
pnpm install
- Stub module with
pnpm dev:prepare
- Start development server using
pnpm dev