https://github.com/hypothesis/epub-demos
Content and deployment instructions for Hypothesis EPUB demos
https://github.com/hypothesis/epub-demos
Last synced: 5 months ago
JSON representation
Content and deployment instructions for Hypothesis EPUB demos
- Host: GitHub
- URL: https://github.com/hypothesis/epub-demos
- Owner: hypothesis
- Created: 2017-08-30T07:01:08.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2022-06-02T14:16:35.000Z (about 4 years ago)
- Last Synced: 2025-08-15T04:42:39.901Z (11 months ago)
- Language: HTML
- Homepage:
- Size: 3.01 MB
- Stars: 3
- Watchers: 12
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hypothesis EPUB Demo Content Library
A curated set of EPUBs for use in demonstrating Hypothesis integration with EPUB
readers, such as ReadiumJS.
This repository is hosted as a static site in an S3 bucket accessible at
`https://cdn.hypothes.is/demos/epub/content/`. You can [browse the library
here](https://cdn.hypothes.is/demos/epub/readium-js/index.html?epubs=%2Fdemos%2Fepub%2Fcontent%2Flibrary.json).
## Usage with ReadiumJS
Use the `epubs` query param to point an instance of the Readium cloud reader at
the `library.json` file from this repository.
For example, assuming that the Readium cloud reader's `index.html` file is
accessible at `http://localhost:8080/index.html` and that the URL of
`library.json` is `http://localhost:8080/hypothesis-epub-content/library.json`:
```
http://localhost:8080/index.html?epubs=http://localhost:8080/hypothesis-epub-content/library.json
```
If the Readium cloud reader is hosted on a different domain than this demo
content, the demo content must allow cross-origin access.
## Deploying content and demos to S3
To deploy updated content to the cdn.hypothes.is S3 bucket:
```sh
export AWS_ACCESS_KEY_ID=
export AWS_SECRET_ACCESS_KEY=
./deploy-content.sh
```
To build and deploy the ReadiumJS and Epub.js viewers, see the [instructions for
deploying the viewers](docs/viewers.md).