Please do not publicize this repository in any way. There are a few known documentation gaps and browser quirks we wish to address before publication. Thank you for your patience.
Scribe is a modern rich text editor built for compatibility and extensibility. It was created by Jason Chen and Byron Milligan and open sourced by Salesforce.com.
To get started, check out the Scribe Github Page or jump straight into the demo.
Instantiate a new Scribe object with a css selector for the div that should become the editor.
<!-- Create the toolbar container -->
<div id="toolbar">
<button class="sc-bold">Bold</button>
<button class="sc-italic">Italic</button>
</div>
<!-- Create the editor container -->
<div id="editor">
<div>Hello World!</div>
</div>
<!-- Include the Scribe library -->
<script src="http://stypi.github.io/scribe/js/scribe.js"></script>
<!-- Initialize Scribe editor -->
<script>
var editor = new Scribe('#editor');
editor.addModule('toolbar', { container: '#toolbar' });
</script>npm install -g grunt-cli
npm install
bundle install
grunt
grunt test - run tests with phantomjs
grunt test:karma - allows you to visit localhost:9876/debug.html for interactive testing
grunt test:local - run tests with locally installed browsers
grunt test:remote - run tests on supported platforms on Sauce Labs
grunt test:exhaust - run exhaustive test suite (used to create unit tests) on PhantomJS
You can use mocha's grep feature to run specific tests ex.
grunt test:local --grep=cursor
Get help by asking questions on Stack Overflow (tag with scribejs). The maintainers of Scribe will actively monitor questions.
Search through Github Issues to see if the bug has already been reported. If so, please comment with any additional information about the bug.
For new issues, create a new issue and tag with the appropriate browser tag. Include as much detail as possible such as:
- Detailed description of faulty behavior
- Affected platforms
- Steps for reproduction
- Failing test case
The more details you provide, the more likely someone will be able to find and fix the bug.
We welcome feature requests. Please make sure they are within scope of Scribe's goals and submit them in Github Issues tagged with the 'feature' tag. The more complete and compelling the request, the more likely it will be implemented. Garnering community support will help as well!
- Please check to make sure your plans fall within Scribe's scope (likely through Github Issues).
- Fork Scribe
- Branch off of the 'develop' branch.
- Implement your changes.
- Submit a Pull Request.
Important: By issuing a Pull Request you agree to allow the project owners to license your work under the terms of the License.
BSD