@nuxtjs/prismic

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

Usage no npm install needed!

<script type="module">
  import nuxtjsPrismic from 'https://cdn.skypack.dev/@nuxtjs/prismic';
</script>

README

@nuxtjs/prismic

npm version npm downloads Github Actions CI Codecov License

@nuxtjs/prismic helps you connect your Nuxt.js application to your content hosted on Prismic

Features

  • Add Prismic to your Nuxt app in seconds
  • Access Prismic SDK with $prismic
  • Prismic previews supported, check out the demo!
  • Compact configuration

📖  Read the documentation

Setup

  1. Add @nuxtjs/prismic dependency to your project:
yarn add @nuxtjs/prismic # or npm install @nuxtjs/prismic
  1. Then, add @nuxtjs/prismic to the buildModules section of nuxt.config.js and configure your Prismic API endpoint:
{
  buildModules: [
    '@nuxtjs/prismic',
  ],
  prismic: {
    endpoint: 'https://<REPOSITORY>.cdn.prismic.io/api/v2',
    modern: true
    // see documentation for more!
  }
}

Development

  1. Clone this repository
  2. Install dependencies using yarn install
  3. Start development server using yarn dev

License

MIT License

Thanks to James Pegg for the initial implementation of the module!