Quick start

Setup

1. Install Sanity integration
   Yarn NPM

   yarn add @nuxtjs/sanity@0.10.0
   

   Copy

   npm install @nuxtjs/sanity@0.10.0 --save
   

   Copy
2. Enable the module in your Nuxt configuration
   Nuxt 2.9+ Nuxt < 2.9

   nuxt.config.js

   {
     buildModules: ['@nuxtjs/sanity/module']
   }
   

   Copy

   nuxt.config.js

   {
     modules: ['@nuxtjs/sanity/module']
   }
   

   Copy
3. Add Sanity configuration
   @nuxtjs/sanity will look for a sanity.json file in your project root directory. Just copy over the sanity.json from your CMS - and you're fully configured!
   Alternatively, you can pass in an object in your Nuxt config with key details.
   nuxt.config.js

   {
     sanity: {
       projectId: 'myProject'
     }
   }
   

   Copy
   You can find more about configuring @nuxtjs/sanityhere.
4. You're good to go!
   Check out how to use Sanity.

TypeScript

@nuxtjs/sanity offers type definitions. Just add an entry in tsconfig.json.

{
  "compilerOptions": {
    "types": ["@nuxt/types", "@nuxtjs/sanity"]
  }
}

{
  "compilerOptions": {
    "types": ["@nuxt/vue-app", "@nuxtjs/sanity"]
  }
}