README.adoc in reverse_asciidoctor-0.2.1 vs README.adoc in reverse_asciidoctor-0.2.2

- old
+ new

@@ -1,7 +1,13 @@ = reverse_asciidoctor +image:https://img.shields.io/gem/v/reverse_asciidoctor.svg["Gem Version", link="https://rubygems.org/gems/reverse_asciidoctor"] +image:https://img.shields.io/travis/metanorma/reverse_asciidoctor/master.svg["Build Status", link="https://travis-ci.org/metanorma/reverse_asciidoctor"] +image:https://codeclimate.com/github/metanorma/reverse_asciidoctor/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/reverse_asciidoctor"] +image:https://ci.appveyor.com/api/projects/status/s4st0ft8moay90m6?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/ribose/reverse-asciidoctor"] + + Based on https://github.com/xijo/reverse_markdown Transforms HTML into asciidoctor. == Requirements @@ -27,22 +33,22 @@ == Usage === Ruby -You can convert html content as string or Nokogiri document: +You can convert HTML content as string or Nokogiri document: [source,ruby] ---- input = '<strong>feelings</strong>' result = ReverseAsciidoctor.convert input result.inspect # " *feelings* " ---- === Commandline -It's also possible to convert html files to markdown using the binary: +It's also possible to convert HTML files to AsciiDoc markup using the binary: [source,console] ---- $ bin/reverse_asciidoctor file.html > file.adoc $ cat file.html | bin/reverse_asciidoctor > file.adoc @@ -135,11 +141,14 @@ Asciidoctor will presumably think this is AsciiMath in the `stem:[ ]` macro, try to pass it into MathJax as AsciiMath, and fail. But of course, MathJax has no problem with MathML, and some postprocessing on the Asciidoctor output can ensure that the MathML is treated by MathJax (or whatever else uses the output) as such; so this is still much better than nothing for stem processing. -** The gem will optionally invoke the https://github.com/riboseinc/mathml2asciimath +** On the other hand, if you are using this gem in the context of https://www.metanorma.com[Metanorma], +Metanorma Asciidoctor accepts MathML as a native mathematical format. So you do not need +to convert the MathML to AsciiMath. +** The gem will optionally invoke the https://github.com/metanorma/mathml2asciimath gem, to convert MathML to AsciiMath. The conversion is not perfect, and will need to be post-edited; but it's a lot better than nothing. The gem does not support: @@ -166,10 +175,10 @@ ** `bypass` - Ignore the unknown tag but try to convert its content ** `raise` - Raise an error to let you know * `tag_border` (default `' '`) - how to handle tag borders. valid options are: ** `' '` - Add whitespace if there is none at tag borders. ** `''` - Do not not add whitespace. -* `mathml2asciimath` - if `true`, will use the https://github.com/riboseinc/mathml2asciimath gem +* `mathml2asciimath` - if `true`, will use the https://github.com/metanorma/mathml2asciimath gem to convert MathML to AsciiMath === As options Just pass your chosen configuration options in after the input. The given options will last for this operation only.