Sir Trevor

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

Quick start

Full documentation can be found here.

Plain JS

• Download the latest release
• ...or clone the repo: git clone git://github.com/madebymany/sir-trevor-js.git
• ...or install with Bower bower install sir-trevor-js

Implementations

1. Sir Trevor Rails
2. Umbraco
3. CakePHP

Custom blocks

We are keeping a list of custom block repos here. See the documentation to find out more about adding your own block types.

Browser support

Sir Trevor is only tested on the following modern browsers:

• IE10+
• Chrome 25+
• Safari 5+
• Firefox 16+

Dependencies

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

Contributing

See the roadmap and read a little about the philosophy guiding development.

Customising the way it looks

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.

Customising blocks

Block Types can also easily be added to the SirTrevor.Blocks object. You can also override the default block types (Text, Image, Tweet, Video, Quote, Heading & List) at any time. See the documentation to find out more about adding your own block types.

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

Convenience 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