Skip to content

vistaprint/ArteJS

Repository files navigation

ArteJS Build Status

ArteJS is a powerful, extensible, configurable, flexible and cross-browser rich text editor with a simple API that produces consistent, valid and concise html.

Authors: See Authors.txt

License: Apache 2

Usage, Demos, Docs

ArteJS Examples / Detailed Documentation

Basic Usage

To use ArteJS in your project, you’ll need to load the following files:

jQuery 1.9.1+ and either dist/arte.js (for development) or the minified version dist/arte.min.js (for production):

<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
<script src="dist/arte.min.js"></script>

Then, invoke the script as follows:

jQuery(function($) {
    var arte = $('#my-editor').Arte();
});

Issues

If you find a bug in ArteJS, please add it to the issue tracker.

Browser Support

TK

Contributing

For detailed information on contributing to ArteJS, check out our CONTRIBUTING.md

Quickstart Guide

First, ensure that you have the latest Node.js and npm installed.

Test that Grunt's CLI is installed by running grunt --version. If the command isn't found, run npm install -g grunt-cli. For more information about installing Grunt, see the getting started guide.

  1. Fork and clone the repo.
  2. Run npm install to install all dependencies (including Grunt).
  3. Run grunt to build the project.