Rich content editing entirely re-imagined for the web
This fork is maintained by Glints to work primarily with markdown, amongst other customizations, to suit our use case more specifically.
Full documentation can be found here.
- 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
Sir Trevor is only tested on the following modern browsers:
- Chrome 25+
- Safari 5+
- Firefox 16+
ECMAScript 6 shims are bundled in by default; if the platform you wish to run on doesn't support ECMAScript 5 APIs you'll need to shim those yourself.
It's up to you:
- Bring your own jQuery or Zepto (and have it put itself on
window.$) and use
- Or if you're using Browserify yourself,
npm install sir-trevorand
require('sir-trevor')it as you would expect.
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.
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.
Before getting started please be sure to install the necessary dependencies via npm:
$ npm install
When completed, we have a couple of preset scripts:
$ npm run dev
This compiles for development, and watches source files to recompile when you change something.
$ npm test
Runs the linter and test suite, just like the CI server does.
$ npm run dist
Concatenates scripts, compiles the Sass, runs the Jasmine tests and minifies the project.
Please ensure any pull requests have relevant Jasmine tests (where applicable).
Sir Trevor is released under the MIT license: opensource.org/licenses/MIT