In-Website Preview

When working in the writing room, authors can preview their new content on their website without having to publish the document.

1. Include the Prismic Toolbar javascript file

Next you need to include the following scripts on every page of your website. Make sure to update <your-repo-name> with the name of the endpoint for your repository.

Copy
<script>
  window.prismic = {
    endpoint: 'https://<your-repo-name>.prismic.io/api'
  };
</script>
<script type="text/javascript" src="//static.cdn.prismic.io/prismic.min.js"></script>

Note for Sharable Previews

To guarantee that Sharable Previews work properly you must ensure that these scripts are included on every page of your website, including your 404/Page Not Found page. Otherwise the Shareable Preview might not work.

2. Setup a preview environment

In your repository, head to the Settings / Previews. Add a site name and the domain for your website where you wish to preview your content. You can also add an optional Link Resolver route which you will learn more about in the next section.

Note that you can also enter localhost domains such as:

Copy
http://localhost:8080

If you are using our official Prismic Java development kit (java-kit), then that is all you need to do to gain the basic functionality of the Preview feature! If you are not using this kit to make your queries, then refer to the "Use the correct ref" section below.

With the basic functionality of the Preview feature, when you click on the preview button, you will be taken to the homepage of your preview domain. From here you can navigate to the page you are trying to preview.

Next we will show you how to add a Link Resolver endpoint so that you will be taken directly to the page you are trying to preview.

In order to be taken directly to the page you are previewing instead of the homepage, you need to add a Link Resolver endpoint. A typical example of this would be:

Copy
http://{yoursite}/preview

In your preview settings add this endpoint to the optional Link Resolver field.

Are you using the Java Spring MVC Starter?

If you are using the official Prismic Java Spring MVC starter project, then you should already have all the code in place you need for In-website previews. That's as much as you need to do!

If you're not using an official Prismic project, then follow the rest of the steps below.

Now you need to add the Link Resolver endpoint in your website application. When requested this endpoint must:

  • Retrieve the preview token from the token parameter in the query string
  • Call the Prismic development kit with this token and the linkResolver will retrieve the correct URL for the document being previewed
  • Redirect to the given URL

The Preview Token

Note that the preview token will be a URL. You DO NOT need to follow this url. All you need to do is pass this token into the previewSession method as shown below

Here is an example preview route using the Spring MVC framework:

Copy
@RequestMapping(path = "/preview")
public String preview(HttpServletRequest request, @RequestParam("token") String token) {
    Api api = (Api) request.getAttribute("prismicapi");
    String url = api.previewSession(token, linkResolver, "/", null);
    return "redirect:" + url;
}

The example above uses a Link Resolver stored in the variable linkResolver to determine the end url to redirect to. To learn more about how to set this up, check out our Link Resolving page.

4. Use the correct reference

The last step to setting up the previews is to make sure that the preview ref is used when you make your queries. Fortunately if you are using the official Prismic Java development kit (java-kit), then the preview ref is automatically used when you retrieve the Api object from the request.

Once all of these pieces are in place, your previews should be up and running!