Skip to content

Latest commit

 

History

History
69 lines (39 loc) · 3.19 KB

Readme.md

File metadata and controls

69 lines (39 loc) · 3.19 KB
Raw

Sir Trevor

Build Status

Sir Trevor in action

Existing WYSIWYG content editors were designed for immutable display media. In contrast, Sir Trevor is rich content editing entirely re-imagined for the web: an intuitive editor for web content which does not presuppose anything about how it will be rendered.

It believes in three guiding principles:

  • Display-neutrality: content must be stored in a clean, structured and standards-based format
  • Technology agnosticism: act as an abstraction layer on top of any technology which can render HTML
  • Extensibility: the interface must be easily extended to include input mechanics for any web-based artefact

Conceived by Andrew Sprinz. Maintained by Chris Bell & Andrew Walker.

Quick start

  1. Download the latest release
  2. Clone the repo: git clone git://github.com/madebymany/sir-trevor-js.git
  3. Install with Bower bower install sir-trevor-js

For Rails based installations, please see the Sir Trevor Rails gem.

Browser support

Sir Trevor is only tested on the following modern browsers:

  1. IE10+
  2. Chrome 25+
  3. Safari 5+
  4. Firefox 16+

Customising

We use Sass for our styles, if you'd like to change the default styling please fork the repository and make changes to the Sass before recompiling. Alternatively, you can override the base styles with your own CSS.

Block Types can also easily be added to the SirTrevor.Blocks object. You can also override the defaulty block types (Text, Image, Tweet, Video, Quote, Heading & List) at any time. Please see the Wiki article about adding your own block types for more information.

Dependencies

Sir Trevor requires Underscore (or LoDash), jQuery (or Zepto) and Eventable.

Building the website

Please see the README in the website folder for more information.

Compiling

We use the awesome Grunt for our build process. Before getting started please be sure to install the necessary dependencies via npm:

$ npm install

When completed you'll be able to run the various grunt commands provided:

$ grunt

Concatenates scripts, compiles the Sass, runs the Jasmine tests and minifies the project.

$ grunt watch

Convienience method while developing to compile the Sass files and concatenate the Javascript on save of a file in the /src directory.

Please ensure any pull requests have relevant Jasmine tests (where applicable).

Licence

Sir Trevor is released under the MIT license: opensource.org/licenses/MIT