Transforms HTML into asciidoctor.
Ruby 1.9.3 or higher
Install the gem
[sudo] gem install reverse_asciidoctor
or add it to your Gemfile
You can convert html content as string or Nokogiri document:
input = '<strong>feelings</strong>' result = ReverseAsciidoctor.convert input result.inspect # " *feelings* "
It’s also possible to convert html files to markdown using the binary:
$ bin/reverse_asciidoctor file.html > file.adoc $ cat file.html | bin/reverse_asciidoctor > file.adoc
In addition, the
bin/w2a script (adapted from the
bin/w2m script in
Ben Balter’s word-to-markdown)
extracts HTML from Word docx documents, and converts it to Asciidoc.
$ bundle exec bin/w2a document.docx > document.adoc
The script presumes that LibreOffice has already been installed: it uses LibreOffice’s export to XHTML. LibreOffice’s export of XHTML is superior to the native Microsoft Word export to HTML: it exports lists (which Word keeps as paragraphs), and it exports OOMML into MathML. On the other hand, the LibreOffice export relies on default styling being used in the document, and it may not cope with ordered lists or headings with customised appearance. For best results, reset the styles in the document you’re converting to those in the default Normal.dot template.
If you wish to convert the MathML in the document to AsciiMath, run the script with the
$ bundle exec bin/w2a --mathml2asciimath document.docx > document.adoc
Note that some information in OOMML is not preserved in the export to MathML from LibreOffice; in particular, font shifts such as double-struck fonts.
Note that the LibreOffice exporter does seem to drop some text (possibly associated with MathML); use with caution.
As a port of reverse_markdown, reverse_asciidoctor shares its features:
Module based - if you miss a tag, just add it
Can deal with nested lists
Inline and block code is supported
It supports the following html tags supported by reverse_markdown:
In addition, it supports:
Lists and paragraphs within cells
Not tables within cells: Asciidoctor cannot deal with nested tabls
It also supports MathML… sort of.
Asciidoctor supports AsciiMath and LaTeX for stem expressions. HTML uses MathML. The gem will recognise MathML expressions in HTML, and will wrap them in Asciidoctor
\$ \$macros. The result of this gem is not actually legal Asciidoctor for stem: Asciidoctor will presumably think this is AsciiMath in the
\$ \$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.
On the other hand, if you are using this gem in the context of 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:
The following options are available:
pass_through) - how to handle unknown tags. Valid options are:
pass_through- Include the unknown tag completely into the result
drop- Drop the unknown tag and its content
bypass- Ignore the unknown tag but try to convert its content
raise- Raise an error to let you know
' ') - how to handle tag borders. valid options are:
' '- Add whitespace if there is none at tag borders.
''- Do not not add whitespace.
true, will use the https://github.com/metanorma/mathml2asciimath gem to convert MathML to AsciiMath
Just pass your chosen configuration options in after the input. The given options will last for this operation only.
ReverseAsciidoctor.convert(input, unknown_tags: :raise, mathml2asciimath: true)
Or configure it block style on a initializer level. These configurations will last for all conversions until they are set to something different.
ReverseAsciidoctor.config do |config| config.unknown_tags = :bypass config.mathml2asciimath = true config.tag_border = '' end
Write custom converters - Wiki entry about how to write your own converter
html_massage - A gem by Harlan T. Wood to convert regular sites into markdown using reverse_markdown
word-to-markdown - Convert word docs into markdown while using reverse_markdown, by Ben Balter