djot

Djot

Djot parser for Ruby, using original JavaScript (jdm/djot.js) implementation.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add djot

If bundler is not being used to manage dependencies, install the gem by executing:

gem install djot

Usage

require 'djot'

Djot.render_html('This is *djot*')
#=> "<p>This is <strong>djot</strong></p>\n"

Djot::JavaScript.parse("- `hello", warn: ->(w) { p w })
#=>
# {"tag"=>"doc",
#  "references"=>{},
#  "footnotes"=>{},
#  "children"=>
#   [{"tag"=>"bullet_list",
#     "tight"=>true,
#     "style"=>"-",
#     "children"=>[{"tag"=>"list_item", "children"=>[{"tag"=>"para", "children"=>[{"tag"=>"str", "text"=>"hello"}]}]}]}]}
#
# stdout:
# {"message"=>"Unclosed verbatim", "offset"=>7}

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test-unit 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 the created tag, and push the .gem file to rubygems.org.

TODO

• Create document class (and more) for idiomatic control in Ruby.
• Write parser in pure Ruby.

Contributing

Bug reports and pull requests are welcome on GitLab. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Acknowledgement

As mentioned earlier, this library only calls the original JavaScript implementation; the important work is done in that library. This gem also uses MiniRacer to call JavaScript source code.

License

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

Code of Conduct

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