Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 3.59 KB

README.md

File metadata and controls

93 lines (61 loc) · 3.59 KB
Raw

For information on the ContentTools 2.x roadmap please view the: Roadmap repo

ContentTools

Build Status

A JS library for building WYSIWYG editors for HTML content.

Demo

Install

Using bower

bower install --save ContentTools

Using npm

npm install --save ContentTools

Building

To build the library you'll need to use Grunt. First install the required node modules (grunt-cli must be installed):

git clone https://github.com/GetmeUK/ContentTools.git
cd ContentTools
npm install

Install Sass (if not already installed):

gem install sass

Then run grunt build to build the project.

Testing

To test the library you'll need to use Jasmine. First install Jasmine:

git clone https://github.com/pivotal/jasmine.git
mkdir ContentTools/jasmine
mv jasmine/dist/jasmine-standalone-2.0.3.zip ContentTools/jasmine
cd ContentTools/jasmine
unzip jasmine-standalone-2.0.3.zip

Then open ContentTools/SpecRunner.html in a browser to run the tests.

Alternatively you can use grunt jasmine to run the tests from the command line.

ContentTools via jsdelivr

ContentTools is available via the jsdelivr open source CDN, to reference a file from the ContentTools build directory use the following URL format:

http://cdn.jsdelivr.net/npm/ContenTools@{version}/{file}

For example to access the current primary JavaScript file the URL would be:

https://cdn.jsdelivr.net/npm/[email protected]/build/content-tools.min.js

As the project's CSS uses relative file paths you will need to either role your own version of CSS from the SASS files (recommended) or override references to fonts/images within your local CSS.

Documentation

Full documentation is available at http://getcontenttools.com/api/content-tools

Where to post...

  • How do I? -- StackOverflow
  • I got this error, why? -- StackOverflow
  • I got this error and I'm sure it's a bug -- post an issue
  • I have an idea/request -- post an issue
  • Why do you? -- chat with me on gitter (I may then post it as an issue)
  • When will you? -- chat with me on gitter (I may then post it as an issue)
  • You suck and I hate you -- contact us privately at [email protected]!
  • You're awesome -- please find a megaphone and suitably high rooftop (but seriously any help spreading the word about ContentTools is much appreciated)

Stolen almost in it's entirety from this post on meta.stackexchange.com

Browser support

The current aim is for all the libraries to support IE9+, Chrome and Firefox. Test suites are complete for all the libraries except ContentTools and I'm using Jasmine to check that the tests pass in those browsers.

There will be some visual differences for ContentTools in IE9 as I use CSS animations for some of the UI feedback.

Helpful organizations

ContentTools is developed using a number of tools & services provided for free by nice folks at organizations committed to supporting open-source projects including BrowserStack, GitHub and jsdelivr, Travis CI.