stipsan / sanity-module

Sanity integration for Nuxt

@nuxtjs/sanity

Sanity integration for Nuxt

• ✨  Release Notes
• 📖  Documentation

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

📖  Read more

Quick setup

1. Add @nuxtjs/sanity dependency to your project

yarn add @nuxtjs/sanity # or npm install @nuxtjs/sanity

2. 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/[email protected] and follow the instructions at https://v0.sanity.nuxtjs.org.

Development

1. Clone this repository
2. Install dependencies using yarn install
3. Start development server using yarn dev

License

MIT License