https://github.com/hypothesis/biotome
A fictional demo site for the Hypothesis integration on biorxiv.org.
https://github.com/hypothesis/biotome
Last synced: 9 months ago
JSON representation
A fictional demo site for the Hypothesis integration on biorxiv.org.
- Host: GitHub
- URL: https://github.com/hypothesis/biotome
- Owner: hypothesis
- Created: 2025-05-08T17:14:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-08T13:33:23.000Z (9 months ago)
- Last Synced: 2025-10-08T15:27:45.992Z (9 months ago)
- Language: CSS
- Homepage: https://biotome.hypothes.is/
- Size: 155 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
bioTome
=======
A fictional demo site for the Hypothesis integration on biorxiv.org. To view the demo site go to .
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:
```html
{
"enableExperimentalNewNoteButton": true,
"externalContainerSelector": "#hypothesis"
}
```
`externalContainerSelector` should be a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) 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: .
Setting up a local bioTome development environment
--------------------------------------------------
First you'll need to install:
* [Git](https://git-scm.com/)
* [Python](https://www.python.org/)
* [GNU Make](https://www.gnu.org/software/make/)
* [entr](https://eradman.com/entrproject/) (on macOS: `brew install entr`)
* [envsubst](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html) (on macOS: `brew install gettext`)
* Local instances of [h](https://github.com/hypothesis/h) and [client](https://github.com/hypothesis/client), which will need to be running
Then to set up your development environment:
```terminal
git clone https://github.com/hypothesis/biotome.git
cd biotome
make dev
```
Now open in a browser to see the demo site.