Git Product home page Git Product logo

epubjs-reader's Introduction

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.

epubjs-reader's People

Contributors

ajrenold avatar fchasen avatar tilgovi avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.