Hosted JavaScript Deployment Overview

If you prefer to serve Schema App's deployment script from your site rather than retrieving it from our content delivery network (CDN), this document outlines the process of hosting our highlight.js deployment script including links to currently supported versions, integration instructions, and other considerations.

How does self-hosting work?

Self-hosting the highlight.js deployment script involves 3 steps:

1. Downloading highlight.js from Schema App's CDN and serving it from your site
2. Embedding a script configuration tag on your site's pages, which is used by highlight.js to create and deploy your schema markup.
3. Whitelisting Schema App, in order to ensure full functionality of our authoring and reporting tools.

Highlight.js Releases

Versions of Schema App highlight.js deployment script can be downloaded from our CDN, to serve and embed directly from your site.

Links to currently supported releases of our deployment script can be found at Highlight.js Releases.

Script configuration tags

The process of deployment is otherwise identical to standard highlight.js integrations.  When self-hosting highlight.js, in addition to serving highlight.js from your site, a script configuration tag must still be added to your page as outlined in Highlighter Deployment Options.

This cript configuration tag needs to be embedded in the page containing your Account ID / Project ID, and any configurations the highlight.js deployment script will use: 

<script>window.schema_highlighter={accountId: "Cupcake", outputCache: true}</script>

Whitelisting Schema App

In order to allow highlight.js to fully function (including markup authoring and reporting), Schema App's IP address, user agent, and API endpoints must be whitelisted.

Instructions on how to whitelist Schema App can be found at Whitelist Schema App IP Address & Endpoints for Full Functionality.

Additional resources

• Schema App JavaScript Deployment Overview
• Highlighter Deployment Options