JSPM

  • Created
  • Published
  • Downloads 4042
  • Score
    100M100P100Q127711F
  • License MIT

Sanity integration for Nuxt

Package Exports

  • @nuxtjs/sanity
  • @nuxtjs/sanity/package.json
  • @nuxtjs/sanity/runtime/client.d.ts
  • @nuxtjs/sanity/runtime/client.mjs
  • @nuxtjs/sanity/runtime/components/sanity-content.d.ts
  • @nuxtjs/sanity/runtime/components/sanity-content.mjs
  • @nuxtjs/sanity/runtime/components/sanity-file.d.ts
  • @nuxtjs/sanity/runtime/components/sanity-file.mjs
  • @nuxtjs/sanity/runtime/components/sanity-image.d.ts
  • @nuxtjs/sanity/runtime/components/sanity-image.mjs
  • @nuxtjs/sanity/runtime/composables.d.ts
  • @nuxtjs/sanity/runtime/composables.mjs
  • @nuxtjs/sanity/runtime/groq.d.ts
  • @nuxtjs/sanity/runtime/groq.mjs
  • @nuxtjs/sanity/runtime/plugin.d.ts
  • @nuxtjs/sanity/runtime/plugin.mjs

Readme

@nuxtjs/sanity

npm version npm downloads Github Actions CI Codecov License

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 yarn install
  3. Start development server using yarn dev

License

MIT License