Embedding Hypothesis in Websites and Platforms

Embedding Hypothesis in Websites and Platforms2021-09-17T14:16:47-07:00
  1. Home
  2. Help
  3. Publisher Partners
  4. Embedding Hypothesis in Websites and Platforms

While individuals can annotate and discuss any page on the Web by equipping their browsers with extensions or bookmarklets, or by using our proxy (via.hypothes.is), publishers can make annotation easier for readers by embedding the Hypothesis client in their websites or platforms.

Embedding Hypothesis

To add Hypothesis to your website or platform, simply add the following line to the HTML source of your page:

<script src="https://hypothes.is/embed.js" async></script>

Configuration

You can configure Hypothesis by including a config tag before the the script tag.

For example, the following arrangement will ensure that our yellow highlights are hidden by default:

<script type="application/json" class="js-hypothesis-config">
{
"showHighlights": false
}
</script>
<script async src="https://hypothes.is/embed.js"></script>

You can find the full list of configuration options in our documentation.

Best practices to optimize your content for annotation

When publishing annotation-friendly documents, be sure to:

Tools, plug-ins and integrations

The Hypothesis community has developed different tools to integrate annotation on websites and explore other functionality using the Hypothesis code and API. Explore all the different ways to include Hypothesis in websites that use WordPress, Drupal, and other platforms. If you’re working with a Content Management System or web site building software and would like to discuss integrating Hypothesis, we’d love to hear about it!

Related Articles

In order to support easy reuse, revision, remixing, and redistribution, the entire Hypothesis Help knowledge base by Hypothesis is dedicated to the public domain via CC CC0 1.0. While we appreciate attribution and links back to Hypothesis from anywhere these works are published, they are not required. Learn more about how we made the decision to put our guidance in the public domain and let us know how you are putting Hypothesis Help to good use.