JSPM

  • Created
  • Published
  • Downloads 15464
  • Score
    100M100P100Q142965F
  • License MIT

Easily connect your Nuxt application to your content hosted on Prismic

Package Exports

    Readme

    @nuxtjs/prismic

    npm version npm downloads Github Actions CI Codecov Conventional Commits License

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

    Features

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

    Quick Setup

    Install the module to your Nuxt application with one command:

    npx nuxi@latest module add prismic

    Then, configure your Prismic API endpoint:

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

    That's it! You can now use Prismic in your Nuxt app ✨

    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