prismic

Easily connect your Nuxt.js application to your content hosted on Prismic

@nuxtjs/prismic

npm versionnpm downloadsGithub Actions CICodecovConventional CommitsLicense

Easily connect your Nuxt.js application to your content hosted on Prismic.

  • 🚀  Add Prismic to your Nuxt app in seconds;
  • 🎣  Access Prismic SDK through composition and options API;
  • 🖼  Prismic previews supported.

Install

npm install --save-dev @nuxtjs/prismic # or yarn add --dev @nuxtjs/prismic

Then, add @nuxtjs/prismic to the modules section of your Nuxt config and configure your Prismic API endpoint:

import { defineNuxtConfig } from 'nuxt'

export default defineNuxtConfig({
    modules: ['@nuxtjs/prismic'],
    prismic: {
        endpoint: 'my-repository'
    },
});

Documentation

To discover what's new on this package check out the changelog. For full documentation, visit the module documentation and Prismic official documentation.

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!

Asking a question: Open a new topic on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.

Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering.

Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more.

Submitting code changes: For small fixes, feel free to open a pull request with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.

License

MIT License