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:
- For pages that may be available at different URLs (and for which you want to share annotations), please see our guidance on document equivalence.
- Include Open Graph Protocol content in your metadata
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!