Sha256: 18d4b0e07a545cb64c58d895c67f82f62254a80ba9158161390b86a1f5eaf4da

Contents?: true

Size: 1.69 KB

Versions: 54

Compression:

Stored size: 1.69 KB

Contents

= mnconvert Ruby gem

image:https://img.shields.io/gem/v/mnconvert.svg["Gem Version", link="https://rubygems.org/gems/mnconvert"]
image:https://github.com/metanorma/mnconvert-ruby/workflows/rake/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/mnconvert-ruby/actions/workflows/rake.yml"]
image:https://codeclimate.com/github/metanorma/mnconvert-ruby/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/mnconvert-ruby"]
image:https://img.shields.io/github/issues-pr-raw/metanorma/mnconvert-ruby.svg["Pull Requests", link="https://github.com/metanorma/mnconvert-ruby/pulls"]
image:https://img.shields.io/github/commits-since/metanorma/mnconvert-ruby/latest.svg["Commits since latest",link="https://github.com/metanorma/mnconvert-ruby/releases"]

== Purpose

The mnconvert Ruby gem is a wrapper around the Java https://github.com/metanorma/mnconvert[mnconvert]
which:

* converts Metanorma presentational XML into various output formats, including
  ISOSTS;
* converts other formats to Metanorma AsciiDoc or Metanorma XML.

This gem is used to provide mnconvert.jar with mirrored version numbers, to allow
Ruby code to easily refer to the desired mnconvert version as dependencies.

== Installation

[source,ruby]
----
gem install mnconvert
----

Or include it in your gemspec.

== Usage

[source,ruby]
----
require 'mnconvert'
MnConvert.convert(sample_xml_path, output_pdf_path)
----

== Updating the gem

Update `lib/mnconvert/version.rb` to the desired version of
https://github.com/metanorma/mnconvert[mnconvert].

Run `rake` to download the `bin/mnconvert.jar` file:

[source,ruby]
----
rm -f bin/mnconvert.jar
rake bin/mnconvert.jar
----

Then release the gem with `rake release`.


Version data entries

54 entries across 54 versions & 1 rubygems

Version Path
mnconvert-1.20.0 README.adoc
mnconvert-1.19.0 README.adoc
mnconvert-1.18.0 README.adoc
mnconvert-1.17.0 README.adoc
mnconvert-1.16.0 README.adoc
mnconvert-1.15.0 README.adoc
mnconvert-1.14.0 README.adoc
mnconvert-1.13.1 README.adoc
mnconvert-1.13.0 README.adoc
mnconvert-1.12.0 README.adoc
mnconvert-1.11.0 README.adoc
mnconvert-1.10.0 README.adoc
mnconvert-1.9.0 README.adoc
mnconvert-1.8.0 README.adoc