Skip to content

Flosciante/sanity-module

 
 

Repository files navigation

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

About

Sanity integration for Nuxt

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 75.2%
  • JavaScript 17.7%
  • Vue 7.0%
  • Shell 0.1%