OERPUB Aloha Editor is a repo for the development of Aloha plugins, models, tests, and examples for use in the production of books and open educational resources. We intend to commit all code back to Aloha when plugins reach maturity.
JavaScript HTML CSS CoffeeScript Other
Pull request Compare This branch is 811 commits ahead, 2 commits behind wysiwhat:master.
Failed to load latest commit information.
.githooks Adds jslint check to pre-commit hook Oct 7, 2012
Editor-Mockups/backgroundShadow Basic html & css experiment with flow canvas, background shadow, fonts Sep 19, 2012
bin Commiting any changes I missed Oct 14, 2012
build remove access to simulation plugin for now Mar 31, 2015
cnx Change format dropdown labels Jun 30, 2015
doc Add TextColor plugin guides Apr 10, 2013
oerpub fix figure counters with subfigures Jun 7, 2014
src use key event instead deprecated keyIdentifier Aug 17, 2016
.gitattributes Fixes line endings see github issue 610 Jul 25, 2012
.gitignore update example editor May 15, 2014
CHANGELOG.md Added changelog Apr 18, 2013
CONTRIBUTING.md Added copyright notice for OERPUB contributions and notice that the C… Oct 21, 2013
LICENSE.txt Change license information to GPLv2 or later or removed redundant inf… Jul 25, 2012
README.md Added copyright notice for OERPUB contributions and notice that the C… Oct 21, 2013
Shuttleworth_funded.png make new gh-pages Dec 3, 2012
aloha-hacks.txt Uploading images broke when an image was dropped into the editor Nov 8, 2012
bower.json Bump Font-Awesome to version 4.4 Aug 31, 2015
cnx.html Moved cnx demo into separate cnx directory Mar 1, 2013
dev-process.png add dev workflow and dev workflow image Feb 27, 2013
dev-workflow.md Update dev-workflow.md Jan 27, 2014
dragfromoutside.html draggable cat examples Sep 19, 2012
figure-and-ribbon-toolbar.html Initial support for dropping filesystem images to replace existing im… Sep 19, 2012
image.html Forgot image plugin Sep 19, 2012
index.html remove wysiwhat from everything which are not demos Jun 7, 2013
package.json remove wysiwhat from everything which are not demos Jun 7, 2013
pom.xml [maven-release-plugin] prepare for next development iteration Apr 18, 2013
quickstart.rst remove wysiwhat from everything which are not demos Jun 7, 2013


Welcome to the OERPUB fork of the Aloha Editor

We are adapting the Aloha editor for creating books, textbooks and other structured content. We are adding mathematics editing and the ability to add educational features like examples, exercises, equations, and glossary entries.

Copyright: Contributions to this repository by the OERPUB project contractors are Copyright (c) 2013 Kathi Fletcher.

Funding: Funding to the OERPUB fork of Aloha Editor for editing textbook content has been funded by the Shuttleworth Foundation through a fellowship and project funds to Kathi Fletcher.

Demos: Thanks for checking us out! You can play with some of our demos by going to our Demo Page

Plugins: Development is done in branches off of master, which are then tested on the dev branch, specifically in the Plugins directory.

Quickstart: To get a development enviroment set up quickly and start working on the editor, use the following instructions. The instructions are for Ubuntu using nginx as the webserver, but you can of course use apache or if you have a mac the webserver that is already present.

Development Workflow: If you develop please look at our dev workflow

The gh-pages branch contains demo HTML files that point to CDN versions of external packages so people can play with the demos. gh-pages is periodically merged from master when new features are released.

Original Aloha Readme follows.

Aloha Editor - The HTML5 WYSIWYG Editor

New Documentation

We're currently writing new new guides. You can find these at /doc/guides/output and on our website: http://aloha-editor.org

For help there is:

To get updates you can:

  • Subscribe to GitHub updates by clicking the "watch" button up the top right of this page.
  • Subscribe to RSS feed updates for the dev branch and/or master branch

Repository Directory Structure

  • /bin - Build scripts
  • /build - Build configuration
  • /doc
  • /doc/api - The API documentation
  • /doc/guides - This document
  • /vendor - Vendor source code. (e.g. ExtJS, require-js, jquery)
  • /target - Build output folder
  • /src
  • /src/css - Aloha core css files
  • /src/demo - Aloha demos
  • /src/img - Aloha core images
  • /src/lib - Require plugins and bootstrap files
  • /src/lib/aloha - Main Aloha Editor core sources
  • /src/lib/vendor - Vendor source code. E.g. ExtJS, jquery
  • /src/lib/util - Utility sources. (e.g. json2.js, class.js)
  • /src/plugins
  • /src/plugins/common - Common plugin bundle
  • /src/plugins/extra - Extra plugin bundle
  • /src/test - QUnit tests