This is a Javascript book editor that saves to GitHub.
Since it is just javascript, it can be hosted on github.com by using the gh-pages branch.
Editing various mime-types is supported by writing plugins (ie SVG, Markdown, etc).
Developers: If you're looking to contribute, check out the TODO section at the bottom of this file!
Unzip an EPUB3 document and push it to GitHub.
This editor uses the GitHub API to read/write EPUB3 files (defined in http://idpf.org/epub/30/spec/epub30-overview.html ).
Below are instructions for building the book editor yourself and a layout of how the code is organized.
- Create a local branch named
gh-pages - Run
npm install .to download the dependencies - Build a minified Javascript file by running
r.js(see https://github.com/jrburke/r.js) - Add the minified Javscript file, commit, and push the changes back to github
Documentation is built using docco.
find . -name "*.coffee" | grep -v './lib/' | grep -v './node_modules' | xargs ./node_modules/docco/bin/docco
Check the ./docs directory to read through the different modules.
-
bookish/*Base models and views for editing books (TOC navigation, HTML content, media resources) -
epub/*Models specific to manipulating EPUB3 books (ie a book is an OPF file plus a separate navigation HTML file) -
gh-book/*GitHub-specific views andBackbone.synccalls that communicate to read/write files to GitHub -
bookish/models.coffeeBackbone Models -
bookish/views.coffeeMarionette Views -
bookish/views/*Handlebars Templates -
bookish/nls/*.coffeei18n strings (and HTML) http://requirejs.org/docs/api.html#i18n -
lib/3rd party libraries -
config/*Custom configuration of 3rd party libraries (Aloha Editor and MathJax) -
config/bookish-config.coffeeIncludes paths to 3rd party libs so we can minify them -
gh-book.coffeeThe starting point for all javascript
-
If a npm version of it exists, add it to
package.json -
Otherwise, add it to
install-libs.sh(which is called when you runnpm install .) -
Add the lib to
config/bookish-config.coffee(both inpathandshim)- The name should be all lowercase
- Use a
-if the library name is more than one word - Don't use
/or.
-
Use it in your module by adding it to the dependencies in
define
There is still a lot of work that needs to be done before this editor is adoptable. Here are some things on my roadmap.
If you're looking to contribute, tackling one of these would be a great place to start!
-
[ ]Add Markdown plugin that edits Markdown and autogenerates HTML (search forMIME_TYPESin the code) -
[X]Save images as resources instead of embedded data URIs (plug into Aloha Upload/Repository API) -
[X]Update the OPF file with added resources -
[ ]Add UI for intra-book links (needs to be separate Aloha plugin) -
[ ]Add "cleanup" button that deletes content/resources that are no longer referred to -
[X]Save<html><head/><body/></html>wrapper around HTML content instead of just saving<div/>tags -
[ ]Generatetoc.ncxfile for EPUB2 compatibility -
[X]Get 'Add Content' working again (when should the id be assigned and the content saved?) -
[X]Notify user when github karma (requests/hour) runs out so they know to sign in -
[X]Only enable Save button when content has changed -
[X]Show user unsaved files -
[X]Only show 'Copy this book!' when the current user is different than the repo user
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent