Developer Documentation

Start building with Prismic.

Choose your framework

If you're starting a new project, we recommend using our developer tool, Slice Machine. The following frameworks integrate with Slice Machine:

Next.js

Nuxt 3

Nuxt 2

For new projects, we strongly recommend using one of the above frameworks. However, we also have SDKs (but no Slice Machine integration) for the following technologies:

Looking for documentation for Ruby, .NET, Java, PHP, or Laravel? It has moved to GitHub.

Looking for documentation for Gatsby? It has moved to GitHub.

Core features

Learn about Prismic's key concepts and features.

Access Token

Query a private repository.

Alpha Page Builder

Try Prismic's new page-building experience.

API

Discover Prismic's API endpoints.

Content Relationship

Data links within your repository.

Field

A content input.

GraphQuery

Deep fetching and selective fetching.

Image

Render and transform images.

Integration

Connections to a third-party data sources.

Locales

Set localized versions of each document

Previews

Preview drafts on your live website.

Rich Text

Customizable text with formatting.

Route Resolver

Generate URLs for your documents.

Slice

A section of a webpage.

Slice Machine

Build components with Prismic.

Type

A document model.

Webhooks

Fire events on repository actions.

Premium features

Some features are only available depending on your subscription.

Import/Export

Import and Export Prismic content.

Environments

Manage content in a development environment.

Deprecated features

These features are not actively supported and will likely be replaced in the near future.

Legacy Type Builder

Build types with Prismic's web-based type editor.

Technical References

Documentation for Prismic's API endpoints.

See the technical reference documentation for Prismic's npm packages:

The following packages are deprecated:

Starter Projects

These starters are a great place to begin if you're new to Prismic. Explore how everything works or use them as starting points for your own projects,

Nuxt

Next.js

React.js

Vue.js

Express.js