/nuxt-sanity

Sanity integration for Nuxt

Primary LanguageTypeScriptMIT LicenseMIT

@nuxtjs/sanity

Nuxt Sanity

npm version npm downloads Codecov License Nuxt Volta

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

📖  Read more

Quick setup

  1. Add @nuxtjs/sanity dependency to your project
yarn add @nuxtjs/sanity # or npm install @nuxtjs/sanity
  1. 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

  1. Clone this repository
  2. Install dependencies using pnpm install
  3. Stub module with pnpm dev:prepare
  4. Start development server using pnpm dev

License

MIT License