https://github.com/nuxt-modules/sanity
Sanity integration for Nuxt
https://github.com/nuxt-modules/sanity
cms hacktoberfest module nuxt nuxt-module sanity sanity-io
Last synced: 3 months ago
JSON representation
Sanity integration for Nuxt
- Host: GitHub
- URL: https://github.com/nuxt-modules/sanity
- Owner: nuxt-modules
- License: mit
- Created: 2020-08-07T18:15:28.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-07-20T15:36:44.000Z (3 months ago)
- Last Synced: 2025-07-20T17:34:34.643Z (3 months ago)
- Topics: cms, hacktoberfest, module, nuxt, nuxt-module, sanity, sanity-io
- Language: TypeScript
- Homepage: https://sanity.nuxtjs.org
- Size: 16.4 MB
- Stars: 245
- Watchers: 5
- Forks: 40
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://sanity.nuxtjs.org)
# Nuxt Sanity
[![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](https://sanity.io/) integration for [Nuxt](https://nuxt.com)
- [✨ Release Notes](https://github.com/nuxt-modules/sanity/releases)
- [📖 Documentation](https://sanity.nuxtjs.org)
## 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](https://sanity.nuxtjs.org)
## Quick setup
1. Add `@nuxtjs/sanity` dependency to your project
```bash
npx nuxi@latest module add sanity
```
2. Add `@nuxtjs/sanity` to the `modules` section of `nuxt.config.ts`
```js
{
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`
3. Start development server using `pnpm dev`
## License
[MIT License](./LICENSE)
[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/sanity/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxtjs/sanity
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/sanity.svg?style=flat&colorA=18181B&colorB=28CF8D
[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://img.shields.io/npm/l/@nuxtjs/sanity.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/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