[![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![Codecov][codecov-src]][codecov-href] [![License][license-src]][license-href] [![Nuxt][nuxt-src]][nuxt-href] [![Volta][volta-src]][volta-href]

Sanity integration for Nuxt

• ✨  Release Notes
• 📖  Documentation

Features

• Just bring your sanity.config.ts - no additional configuration required
• Ultra-lightweight Sanity client
• Zero-config image/file components + portable text renderer
• Supports GROQ syntax highlighting

Quick setup

1. Add @nuxtjs/sanity dependency to your project

npx nuxi@latest module add 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/[email protected] 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

[npm-version-src]: https://npmx.dev/api/registry/badge/version/@nuxtjs/sanity [npm-version-href]: https://npmx.dev/package/@nuxtjs/sanity [npm-downloads-src]: https://npmx.dev/api/registry/badge/downloads/@nuxtjs/sanity [npm-downloads-href]: https://npm.chart.dev/@nuxtjs/sanity [codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/sanity.svg?style=flat&colorA=18181B&colorB=28CF8D [codecov-href]: https://codecov.io/gh/nuxt-modules/sanity [license-src]: https://npmx.dev/api/registry/badge/license/@nuxtjs/sanity [license-href]: https://npmx.dev/package/@nuxtjs/sanity [volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg [volta-href]: https://volta.net/nuxt-modules/sanity?utm_source=readme_nuxt_sanity [nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?&logo=nuxt.js [nuxt-href]: https://nuxt.com