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/internal/useSanityQueryFetcher.d.ts
- @nuxtjs/sanity/runtime/composables/internal/useSanityQueryFetcher.js
- @nuxtjs/sanity/runtime/composables/internal/useSanityTagRevalidation.d.ts
- @nuxtjs/sanity/runtime/composables/internal/useSanityTagRevalidation.js
- @nuxtjs/sanity/runtime/composables/useIsSanityLivePreview.d.ts
- @nuxtjs/sanity/runtime/composables/useIsSanityLivePreview.js
- @nuxtjs/sanity/runtime/composables/useIsSanityPresentationTool.d.ts
- @nuxtjs/sanity/runtime/composables/useIsSanityPresentationTool.js
- @nuxtjs/sanity/runtime/composables/useLazySanityQuery.d.ts
- @nuxtjs/sanity/runtime/composables/useLazySanityQuery.js
- @nuxtjs/sanity/runtime/composables/useSanity.d.ts
- @nuxtjs/sanity/runtime/composables/useSanity.js
- @nuxtjs/sanity/runtime/composables/useSanityConfig.d.ts
- @nuxtjs/sanity/runtime/composables/useSanityConfig.js
- @nuxtjs/sanity/runtime/composables/useSanityLiveMode.d.ts
- @nuxtjs/sanity/runtime/composables/useSanityLiveMode.js
- @nuxtjs/sanity/runtime/composables/useSanityPerspective.d.ts
- @nuxtjs/sanity/runtime/composables/useSanityPerspective.js
- @nuxtjs/sanity/runtime/composables/useSanityPreviewEnvironment.d.ts
- @nuxtjs/sanity/runtime/composables/useSanityPreviewEnvironment.js
- @nuxtjs/sanity/runtime/composables/useSanityPreviewPerspective.d.ts
- @nuxtjs/sanity/runtime/composables/useSanityPreviewPerspective.js
- @nuxtjs/sanity/runtime/composables/useSanityQuery.d.ts
- @nuxtjs/sanity/runtime/composables/useSanityQuery.js
- @nuxtjs/sanity/runtime/composables/useSanityVisualEditing.d.ts
- @nuxtjs/sanity/runtime/composables/useSanityVisualEditing.js
- @nuxtjs/sanity/runtime/composables/useSanityVisualEditingState.d.ts
- @nuxtjs/sanity/runtime/composables/useSanityVisualEditingState.js
- @nuxtjs/sanity/runtime/constants.d.ts
- @nuxtjs/sanity/runtime/constants.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/live-content.client.d.ts
- @nuxtjs/sanity/runtime/plugins/live-content.client.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/preview/proxy.d.ts
- @nuxtjs/sanity/runtime/server/routes/preview/proxy.js
- @nuxtjs/sanity/runtime/server/tsconfig.json
- @nuxtjs/sanity/runtime/server/utils/index.d.ts
- @nuxtjs/sanity/runtime/server/utils/index.js
- @nuxtjs/sanity/runtime/types.d.ts
- @nuxtjs/sanity/runtime/types.js
- @nuxtjs/sanity/runtime/util/createLiveStore.d.ts
- @nuxtjs/sanity/runtime/util/createLiveStore.js
- @nuxtjs/sanity/runtime/util/createProxyClient.d.ts
- @nuxtjs/sanity/runtime/util/createProxyClient.js
- @nuxtjs/sanity/runtime/util/createQueryStore.d.ts
- @nuxtjs/sanity/runtime/util/createQueryStore.js
Readme
Nuxt Sanity
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
Quick setup
- Add
@nuxtjs/sanity
dependency to your project
npx nuxi@latest module add sanity
- Add
@nuxtjs/sanity
to themodules
section ofnuxt.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
- Clone this repository
- Install dependencies using
pnpm install
- Stub module with
pnpm dev:prepare
- Start development server using
pnpm dev