sanity

Access text, images, and other media with Nuxt and the Sanity headless CMS.

12.2K downloads

•

danielroe

Nuxt Sanity

Sanity integration for Nuxt

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 the modules section of nuxt.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

License