Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nuxt-modules/prismic
Easily connect your Nuxt.js application to your content hosted on Prismic
https://github.com/nuxt-modules/prismic
nuxt nuxt-module prismic prismicio vue
Last synced: 4 months ago
JSON representation
Easily connect your Nuxt.js application to your content hosted on Prismic
- Host: GitHub
- URL: https://github.com/nuxt-modules/prismic
- Owner: nuxt-modules
- License: mit
- Created: 2018-09-09T20:25:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T16:41:50.000Z (5 months ago)
- Last Synced: 2024-09-17T16:52:59.347Z (5 months ago)
- Topics: nuxt, nuxt-module, prismic, prismicio, vue
- Language: TypeScript
- Homepage: https://prismic.nuxtjs.org
- Size: 5.98 MB
- Stars: 244
- Watchers: 8
- Forks: 48
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @nuxtjs/prismic
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![Conventional Commits][conventional-commits-src]][conventional-commits-href]
[![License][license-src]][license-href]
Easily connect your Nuxt.js application to your content hosted on [Prismic][prismic].
- [✨ Release Notes][changelog]
- [🏀 Online Playground][playground]
- [📖 Module Documentation][nuxt-docs]
- [📚 Prismic Documentation][prismic-docs]
## 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:
```bash
npx nuxi module add prismic
```
Then, configure your Prismic API endpoint:
```javascript
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][forum-question] 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][repo-bug-report] explaining your application's setup and the bug you're encountering.
**Suggesting an improvement**: [Open an issue][repo-feature-request] 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][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.
## License
[MIT License](./LICENSE)
[prismic]: https://prismic.io
[playground]: https://stackblitz.com/github/nuxt-modules/prismic/tree/master/examples/minimal?file=pages%2Findex.vue
[nuxt-docs]: https://prismic.nuxtjs.org
[prismic-docs]: https://prismic.io/docs/technical-reference/prismicio-vue?version=v4
[changelog]: ./CHANGELOG.md
[contributing]: ./CONTRIBUTING.md
[forum-question]: https://community.prismic.io
[repo-bug-report]: https://github.com/nuxt-modules/prismic/issues/new?assignees=&labels=bug&template=bug_report.md&title=
[repo-feature-request]: https://github.com/nuxt-modules/prismic/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
[repo-pull-requests]: https://github.com/nuxt-modules/prismic/pulls
[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/prismic/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/@nuxtjs/prismic
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/prismic.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/prismic
[github-actions-ci-src]: https://img.shields.io/github/actions/workflow/status/nuxt-modules/prismic/ci.yml.svg?style=flat&colorA=020420&colorB=00DC82
[github-actions-ci-href]: https://github.com/nuxt-modules/prismic/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/prismic.svg?style=flat&colorA=020420&colorB=00DC82
[codecov-href]: https://codecov.io/gh/nuxt-modules/prismic
[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat&colorA=020420&colorB=00DC82
[conventional-commits-href]: https://conventionalcommits.org
[license-src]: https://img.shields.io/npm/l/@nuxtjs/prismic.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/@nuxtjs/prismic