https://github.com/prismicio-community/eleventy-plugin-prismic

Eleventy plugin and shortcodes to fetch and present Prismic content
https://github.com/prismicio-community/eleventy-plugin-prismic

11ty 11ty-plugin eleventy eleventy-plugin javascript prismic typescript

Last synced: about 2 months ago
JSON representation

Eleventy plugin and shortcodes to fetch and present Prismic content

• Host: GitHub
• URL: https://github.com/prismicio-community/eleventy-plugin-prismic
• Owner: prismicio-community
• License: mit
• Created: 2021-04-26T15:59:06.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-12-20T20:58:35.000Z (almost 2 years ago)
• Last Synced: 2024-07-04T19:43:49.469Z (3 months ago)
• Topics: 11ty, 11ty-plugin, eleventy, eleventy-plugin, javascript, prismic, typescript
• Language: TypeScript
• Homepage: https://github.com/prismicio-community/eleventy-plugin-prismic/blob/master/DOCUMENTATION.md
• Size: 2.42 MB
• Stars: 98
• Watchers: 5
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-prismic - eleventy-plugin-prismic - 11ty development kit. _\*_ (Ecosystem / Development Kits)

README

        


# eleventy-plugin-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]

[Eleventy][eleventy] plugin and shortcodes to fetch and present [Prismic][prismic] content.

- 🎣  Inject Prismic content into Eleventy data;

- 🧰  Display content Prismic with provided shortcodes;

- 📦  Batteries included, no need for extra Prismic dependencies.

## Install

```bash

npm install eleventy-plugin-prismic

```

## Documentation

To discover what's new on this package check out [the changelog][changelog]. For full documentation, check out the [dedicated document][documentation] (GitHub).

## 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.

For more clarity on this project and its structure you can also check out the detailed [CONTRIBUTING.md][contributing] document.

## License

[MIT License][license]

[prismic]: https://prismic.io

[eleventy]: https://11ty.dev

[documentation]: ./DOCUMENTATION.md

[changelog]: ./CHANGELOG.md

[contributing]: ./CONTRIBUTING.md

[license]: ./LICENSE

[forum-question]: https://community.prismic.io

[repo-bug-report]: https://github.com/prismicio-community/eleventy-plugin-prismic/issues/new?assignees=&labels=bug&template=bug_report.md&title=

[repo-feature-request]: https://github.com/prismicio-community/eleventy-plugin-prismic/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=

[repo-pull-requests]: https://github.com/prismicio-community/eleventy-plugin-prismic/pulls

[npm-version-src]: https://img.shields.io/npm/v/eleventy-plugin-prismic/latest.svg

[npm-version-href]: https://npmjs.com/package/eleventy-plugin-prismic

[npm-downloads-src]: https://img.shields.io/npm/dm/eleventy-plugin-prismic.svg

[npm-downloads-href]: https://npmjs.com/package/eleventy-plugin-prismic

[github-actions-ci-src]: https://github.com/prismicio-community/eleventy-plugin-prismic/workflows/ci/badge.svg

[github-actions-ci-href]: https://github.com/prismicio-community/eleventy-plugin-prismic/actions?query=workflow%3Aci

[codecov-src]: https://img.shields.io/codecov/c/github/prismicio-community/eleventy-plugin-prismic.svg

[codecov-href]: https://codecov.io/gh/prismicio-community/eleventy-plugin-prismic

[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg

[conventional-commits-href]: https://conventionalcommits.org

[license-src]: https://img.shields.io/npm/l/eleventy-plugin-prismic.svg

[license-href]: https://npmjs.com/package/eleventy-plugin-prismic