README.md

RenderEditorjs

A modular and customizable Ruby renderer for Editor.js.

This gem takes inspiration from editor_js. It copies some code blocks logic and schema validations. The editor_js gem implements the most common blocks. If you don't need any customization, it would make sense to try it.

In comparison, RenderEditorjs (this gem) only implement a few blocks, but you can customize and extend it with your blocks.

Sponsor

This project is sponsored by babelfu.com

Installation

Add this line to your application's Gemfile:

gem 'render_editorjs'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install render_editorjs

Usage

RenderEditorjs expects an Editor.js JSON as input; it can be a JSON serialized as a string or a Hash.

Basic usage

RenderEditorjs.render(json) #=> HTML...

Common usage

renderer = RenderEditorjs::DefaultRenderer.new
document = RenderEditorjs::Document.new(json, renderer)

document.valid? #=> true | false
document.errors #=> Array with the schema errors
document.render #=> HTML...

Advanced usage

Customize the DefaultRenderer adding or overriding blocks:

renderer = RenderEditorjs::DefaultRenderer.new("header" => MyCustomHeader.new, "customBlock" => CustomBlock.new)
document = RenderEditorjs::Document.new(json, renderer)
document.render #=> My custom HTML

Create your renderer class:

renderer = MyOwnRenderer.new
document = RenderEditorjs::Document.new(json, renderer)
document.render #=> My custom HTML

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ceritium/render_editorjs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the RenderEditorjs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.