jekyll-asciimath 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e9b8cf3a6a1d6136d911e0bbd9cc4b9447fd332eae240c82696a52ff4941ee2
-  data.tar.gz: 95b5ffe13981239048b7d323b7897662ee4ddcaa9615e61af460a79714524c11
+  metadata.gz: ee69a35a602bc339cc9e640608e09d0fcf5e53232d20f07c28dc5540a69a9161
+  data.tar.gz: a9ac991b8cbddf6d39f70afb4815986c8ffefb211f768d2850fa755788aa3ee5
 SHA512:
-  metadata.gz: 8100dcec170c83500d3aeff55322701f637f5ee7f2834ab0799cb4bd56c59f685da415f118420fa69b40d87e7758965f1d93e7854fdc7fb34570db3fda211b47
-  data.tar.gz: bf51be49b8684d3a43a566384f37c55c9bc29ed429d2c3448bac52fe0856385fff6375bbf7930b5782c292dcebf3ef30de6732ed846894576bb4af67f575595b
+  metadata.gz: b3fef3cd9c5e855fea865c03b6d2691992808627a3ae18fa7ca3bc15b21e22c9fd77d9315d7630e716c704c5bfdbc07e5de44f802daf595adfad31afa15c2c73
+  data.tar.gz: f3a8c317835ec8cfb1d488a0edfc48116ec7d7491a6464a2f01d5f1232f5eac3fc711e5e73c7355403b8ab5f85e0631288bbf079aa82ae0ecd17e886f6de1d30

data/CHANGELOG.adoc

@@ -1,5 +1,9 @@
 = Changelog
 
+== 1.1.0
+
+Adds support for MathML as output format.
+
 == 1.0.0
 
 The initial version of the plugin.

data/README.adoc

@@ -3,7 +3,7 @@
 == `asciimath` filter
 
 When applied to a variable, replaces AsciiMath markup between specified delimiters
-with HTML.
+with MathML or HTML.
 
 For example, Liquid markup like this:
 
@@ -16,6 +16,25 @@ For example, Liquid markup like this:
 would be rendered into this
 (but without whitespace, which is added for legibility):
 
+MathML:
+
+[source,html]
+--
+<math>
+  <mi>m</mi>
+</math>
+
+out of
+
+<math>
+  <mi>n</mi>
+</math>
+
+redundancy
+--
+
+HTML:
+
 [source,html]
 --
 <span class="math-inline">
@@ -37,7 +56,8 @@ redundancy
 
 == How it works
 
-This plugin uses https://github.com/asciidoctor/asciimath for converting AsciiMath into HTML,
+This plugin uses https://github.com/asciidoctor/asciimath for converting AsciiMath
+into MathML and HTML,
 and a crude regular expression for extracting AsciiMath markup from a mass of text
 based on delimiters.
 
@@ -47,6 +67,25 @@ The plugin will work without any site configuration keys,
 but it requires you to include AsciiMath styling CSS in your template
 and to pay attention to the default delimiter setting (see below).
 
+=== Output format
+
+Depending on the browsers you intend to support, you may choose
+MathML or HTML as the output format. Native MathML support is available
+for most browsers, except MSIE.
+
+Configure the delimiter for use with `asciimath` filters in your site config
+as follows:
+
+[source,yaml]
+--
+asciimath_output_format: mathml
+--
+
+Valid choices: `mathml` (default), `html`.
+
+For best rendering results, choose `mathml`.
+
+
 === Delimiter
 
 Currently, only one delimiter is supported

data/jekyll-asciimath.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'jekyll-asciimath'
-  s.version       = '1.0.0'
+  s.version       = '1.1.0'
   s.authors       = ['Ribose Inc.']
   s.email         = ['open.source@ribose.com']
 

data/lib/jekyll_asciimath/jekyll_asciimath.rb

@@ -13,25 +13,29 @@ end
 
 module Jekyll::AsciiMathFilter
   def asciimath(input)
-    delimiter = @context.registers[:site].config['asciimath_delimiter'] || '$$'
+    site_config = @context.registers[:site].config
+
+    delimiter = site_config['asciimath_delimiter'] || '$$'
+    output_format = site_config['asciimath_output_format']
+    output_format = 'mathml' unless %w(html mathml).include?(output_format)
+
     delim_regex = Regexp.quote(delimiter)
     asciimath_regex = Regexp.new("(?<=#{delim_regex})[^#{delim_regex}]+(?=#{delim_regex})")
 
-    if input.scan(asciimath_regex).size > 0
-      pieces = "#{delimiter} #{input} #{delimiter}".scan(asciimath_regex)
-      parsed_pieces = []
-
-      pieces.each_with_index { |piece, idx|
-        if idx.odd?
-          parsed_pieces << AsciiMath.parse(piece).to_html
-        elsif piece != ' '
-          parsed_pieces << piece
-        end
-      }
-      return parsed_pieces.join('')
-    else
-      return input
-    end
+    return input if input.scan(asciimath_regex).size == 0
+
+    pieces = "#{delimiter} #{input} #{delimiter}".scan(asciimath_regex)
+    parsed_pieces = []
+
+    pieces.each_with_index { |piece, idx|
+      if idx.odd?
+        parsed_pieces << AsciiMath.parse(piece).send("to_#{output_format}")
+      elsif piece != ' '
+        parsed_pieces << piece
+      end
+    }
+
+    parsed_pieces.join('')
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-asciimath
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-11 00:00:00.000000000 Z
+date: 2020-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll