Giters

shunito / bibi

BiB/i | EPUB Reader on your web site.

Home Page:http://bibi.epub.link/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BiB/i

EPUB Reader on your website.

  1. How to setup & read/publish EPUB books (for users)

  2. How to arrange development environment (for developers)

  3. License

  4. How to setup & read/publish EPUB books

BiB/i supports two ways to read/publish EPUB books:

  • Read in browsers on your local machine, or
  • Publish on the web, to have your books read by someone.

In either case, download BiB/i from web site and unzip it at first.

Read in browsers on your local machine

  1. Open bib/i/index.html in your browser and
  2. Drag an EPUB book and drop it into the window.
  3. That's all!

Publish on the web

Demo.

You can publish both zipped archive and unzipped folder. (Using unzipped is highly recommended.)

Use zipped archives

  1. Upload bib directory to your web server,
  2. Upload your EPUB books(for instance, my-book.epub here) to bib/bookshelf directory, and
  3. Access to http://your.web.site/bib/i/?book=my-book.epub by your browser.
  4. Or embed code below into your blog and visit the blog entry.
<a href="http://your.web.site/somewhere/bib/i/?book=my-book.epub" data-bibi="embed" data-bibi-style="[[ CSS for embeded BiB/i, as you like ]]">My Great Book Title</a><script src="http://your.web.site/bib/i.js"></script>

Use unzipped archives (recommended)

You may also read EPUB books as unzipped archives, or by page-by-page access, by uploading unzipped EPUB books to bookshelf directory. This is recommended because it accelarates reading experience of your readers.

  1. Unzip an EPUB book,
    1. Change the file extension from .epub to .zip(my-book.epub -> my-book.zip) and then
    2. unzip the file with some tool.
  2. Upload it to bib/bookshelf directory, and
  3. Visit http://your.web.site/bib/i/?book=my-book (note that it has No Extension) or embed code for it.
<a href="http://your.web.site/somewhere/bib/i/?book=my-book" data-bibi="embed" data-bibi-style="[[ CSS for embeded BiB/i, as you like ]]">My Great Book Title</a><script src="http://your.web.site/bib/i.js"></script>
  1. How to arrange development environment

Requirements

  1. Node.js + npm - guide: “Download the installer” (or “Installing Node.js via package manager”)
  2. Ruby (+ RubyGems) - guide: “Installing Ruby” (+ “RubyGems Basics”)
  3. Bundler - how to install: $ gem update --system && gem install bundler
  4. Grunt - how to install: $ npm install -g grunt-cli ... (“Getting Started”)

Arrangements

  1. Clone this repository. (https://github.com/satorumurmur/bibi/)
  2. $ cd <the repository>
  3. $ bundle install --path=vendor/bundle then vendor/bundle directory including RubyGems(Compass and dependent gems) will be installed.
  4. $ npm install then npm-modules directory including modules will be installed.

Development

  1. $ grunt and start watching changes of files, and make these files:
    • bib/i/res/scripts/bibi.js ... JSZip.js + base64.js + easing.js + sML.js + bibi.core.js + bibi.epubcfi.js
    • bib/i/res/styles/bibi.css
    • bib/i/res/styles/pipi.css ... (formerly bib/i.css, for embedding BiB/i to webpage)
  2. Edit files.
    • JavaScript sources of the bib/i/res/scripts/bibi.js are in bibi-dev/res/scripts/lib/ and bibi-dev/res/scripts/src/.
    • SCSS sources of the bib/i/res/styles/bibi.css and bib/i/res/styles/pipi.css are in bibi-dev/res/styles/src/.

Following files are not watched or processed by Grunt tasks:

  • bib/i/index.html (as portal)
  • bib/i.js (for embedding in HTML webpage)
  • bib/manifest.json (for using as Chrome application)
  • Files in bib/presets/ (customisable settings and styles)
  • Files in bib/i/res/fonts/ (icon fonts)

And bib/bookshelf/ directory is including .gitkeep

  1. License

BiB/i

BiB/i is including these softwares

About

BiB/i | EPUB Reader on your web site.

http://bibi.epub.link/

License:MIT License

Languages

Language:JavaScript 73.9%Language:CSS 25.9%Language:Ruby 0.2%