JSPM

  • Created
  • Published
  • Downloads 3841
  • Score
    100M100P100Q127326F
  • License MIT

Sanity integration for Nuxt

Package Exports

  • @nuxtjs/sanity
  • @nuxtjs/sanity/package.json
  • @nuxtjs/sanity/runtime/client.d.ts
  • @nuxtjs/sanity/runtime/client.js
  • @nuxtjs/sanity/runtime/components/sanity-content.d.ts
  • @nuxtjs/sanity/runtime/components/sanity-content.js
  • @nuxtjs/sanity/runtime/components/sanity-file.d.ts
  • @nuxtjs/sanity/runtime/components/sanity-file.js
  • @nuxtjs/sanity/runtime/components/sanity-image.d.ts
  • @nuxtjs/sanity/runtime/components/sanity-image.js
  • @nuxtjs/sanity/runtime/composables/index.d.ts
  • @nuxtjs/sanity/runtime/composables/index.js
  • @nuxtjs/sanity/runtime/composables/visual-editing.d.ts
  • @nuxtjs/sanity/runtime/composables/visual-editing.js
  • @nuxtjs/sanity/runtime/groq.d.ts
  • @nuxtjs/sanity/runtime/groq.js
  • @nuxtjs/sanity/runtime/minimal-client.d.ts
  • @nuxtjs/sanity/runtime/minimal-client.js
  • @nuxtjs/sanity/runtime/plugins/global-helper.d.ts
  • @nuxtjs/sanity/runtime/plugins/global-helper.js
  • @nuxtjs/sanity/runtime/plugins/visual-editing.client.d.ts
  • @nuxtjs/sanity/runtime/plugins/visual-editing.client.js
  • @nuxtjs/sanity/runtime/plugins/visual-editing.server.d.ts
  • @nuxtjs/sanity/runtime/plugins/visual-editing.server.js
  • @nuxtjs/sanity/runtime/server/routes/preview/disable.d.ts
  • @nuxtjs/sanity/runtime/server/routes/preview/disable.js
  • @nuxtjs/sanity/runtime/server/routes/preview/enable.d.ts
  • @nuxtjs/sanity/runtime/server/routes/preview/enable.js
  • @nuxtjs/sanity/runtime/server/routes/proxy.d.ts
  • @nuxtjs/sanity/runtime/server/routes/proxy.js
  • @nuxtjs/sanity/runtime/server/tsconfig.json
  • @nuxtjs/sanity/runtime/server/utils/index.d.ts
  • @nuxtjs/sanity/runtime/server/utils/index.js

Readme

@nuxtjs/sanity

Nuxt Sanity

npm version npm downloads Codecov License Nuxt Volta

Sanity integration for Nuxt

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
  • Nuxt 3 and Nuxt Bridge support

📖  Read more

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/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