Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 2 KB

README.md

File metadata and controls

80 lines (52 loc) · 2 KB

Epub.js Reader

Demo

Try it while reading Moby Dick

About the Reader

This reader came out of the Berkeley Future of eBooks classes in Fall & Spring 2013. It renders a ePub version of the TDO book using the Epub.js library.

It is very much still a work in progress, so please bear with us. We would greatly appreciate reports on any bug or issues you come across

Getting Started

All the rendering is encapsulated within Angular directives.

<epubreader> has only a src attribute and will render the complete reader.

<epubreader src="/moby-dick/"></epubreader>

<epubviewer> has several more attributes, requiring only only a src and will display just the basic epub, without the rest of the interface elements.

<epubviewer src="{{src}}"></epubviewer>

Other available attributes are:

  • on-ready
  • on-chapter-displayed
  • on-page-changed
  • path
  • cfi
  • metadata
  • toc

Annotations with Hypothes.is

hypothes.is/what-is-it/

Hypothes.is is the nonprofit that has developed the annotation platform you can use in combination with the reader.

In order to use the annotation tool, you must sign up for a Hypothes.is account.

  • Click the dialogue icon dialogue on the right.
  • Select the “Create an account” tab.
  • Select a username and password.

Deploying to App Engine

Update the app.yaml with you application id.

Then run:

appcfg.py update .

Additional Resources

Epub.js Developer Mailing List

IRC Server: freenode.net Channel: #epub.js

Follow us on twitter: @Epubjs

Other

EPUB is a registered trademark of the IDPF.