bioTome

A fictional demo site for the Hypothesis integration on biorxiv.org. To view the demo site go to https://biotome.hypothes.is/.

Adding Hypothesis to a website

To embed Hypothesis into a site like in the demo linked above you just need to add a couple of scripts to your site's HTML:

<script type="application/json" class="js-hypothesis-config">
  {
    "commentsMode": true,
    "showHighlights": false,
    "enableExperimentalNewNoteButton": true,
    "groupsAllowlist": ["group_one_id", "group_two_id"],
    "externalContainerSelector": "#hypothesis"
  }
</script>
<script async src="https://hypothes.is/embed.js"></script>

externalContainerSelector should be a CSS selector that selects the HTML element on your page where you want Hypothesis to appear.

For documentation, including all the settings you can use in the js-hypothesis-config object, see: https://h.readthedocs.io/projects/client/en/latest/publishers/embedding.html.

Setting up a local bioTome development environment

First you'll need to install:

• Git
• Python
• GNU Make
• entr (on macOS: brew install entr)
• envsubst (on macOS: brew install gettext)
• Local instances of h and client, which will need to be running

Then to set up your development environment:

git clone https://github.com/hypothesis/biotome.git
cd biotome
make dev

Now open http://localhost:47291/ in a browser to see the demo site.