jekyll-katex 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f8555cfba1bff00546aa0efe7d14400dceaa5ef15ef213b711b931be779e9e6
-  data.tar.gz: d79b83fce0fce8b81493890c811b6c10963f104b561d6601649741a15ea54fbd
+  metadata.gz: e5f8bbfb06ad51bf7782cdad251226adc466b011e805786e4378ffcb1cfb1ab2
+  data.tar.gz: de2ef5092e27eb79891320b0aaa04f31adbe0b76118c09baa9cce59126e49e42
 SHA512:
-  metadata.gz: 9ef2b92701cfe49965afc1bc40ab6df000dbf20d51454f3d7834fabd9da5d73f1622c0c432d54db1ba26e08963f02ff2229d1c7a1888e0bf7098b2d11b1f96fc
-  data.tar.gz: 2307ffc5f8c2b24d46ed3dd180c0348fb17f2da9b5ff5122536d43154472356134573785ae6cef3d1495bac8557bcf7ce7c89cfe1bd7ad2b0dacf4c3e7f2ab78
+  metadata.gz: 4e434cb16965dd70fc3440b33d6a05f93d9b1db7bf2d5889ef9eb98a2fccc0c127419f3f58cd4b4e0fde9a7fd0400c7ec1bd8a89275f7b6d38df37434a65ccc6
+  data.tar.gz: 652891ab56be42eeaa49841d0eb3b4ff77a0b31bc2927837cd37cfd6221d70c83c0cd3badac31335d8c85a0b290e75295c8b6599e3b67e56c11677c0261c9e17

data/README.md

@@ -53,6 +53,10 @@ katex:
 
 ## Usage
 
+There are two liquid tags: `katex` and `katexmm`.
+
+### katex
+
 Use the `katex` liquid tag for LaTeX math equations like so:
 
 ```latex
@@ -69,6 +73,22 @@ c = \pm\sqrt{a^2 + b^2}
 {% endkatex %}
 ```
 
+### katexmm
+
+The `katex` liquid tag can be cumbersome, particularly if you have many inline blocks, which would need to be opened
+and closed repeatedly, cluttering the source text. `katexmm` is an alternative that supports fenced math mode blocks
+similar to standard latex:
+
+```latex
+{% katexmm %}
+This is a mixed environment where you can have text and normal text and $c = \pm\sqrt{a^2 + b^2}$ fenced math. \$!
+{% endkatexmm %}
+```
+
+* `$` for inline
+* `$$` for display mode
+* `\$` to escape `$` anywhere within the `katexmm` environment
+
 ## Development
 
 ```bash

data/gems.locked

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-katex (0.2.0)
+    jekyll-katex (0.3.0)
       execjs (~> 2.7)
       jekyll (~> 3.8)
 
@@ -25,7 +25,7 @@ GEM
     http_parser.rb (0.6.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.3)
+    jekyll (3.8.4)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -51,31 +51,31 @@ GEM
       ruby_dep (~> 1.2)
     mercenary (0.3.6)
     parallel (1.12.1)
-    parser (2.5.1.0)
+    parser (2.5.1.2)
       ast (~> 2.4.0)
     pathutil (0.16.1)
       forwardable-extended (~> 2.6)
-    powerpack (0.1.1)
-    public_suffix (3.0.2)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
     rainbow (3.0.0)
     rake (12.3.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
-    rouge (3.1.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rouge (3.2.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     rubocop (0.56.0)
       parallel (~> 1.10)
       parser (>= 2.5)
@@ -83,10 +83,10 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
+    ruby-progressbar (1.10.0)
     ruby_dep (1.5.0)
     safe_yaml (1.0.4)
-    sass (3.5.6)
+    sass (3.6.0)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -110,4 +110,4 @@ DEPENDENCIES
   simplecov (~> 0.16)
 
 BUNDLED WITH
-   1.16.2
+   1.16.3

data/lib/jekyll/tags/katex.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'execjs'
 require 'jekyll-katex/configuration'
+require 'jekyll-katex/katex_js'
 
 module Jekyll
   module Tags
@@ -11,7 +11,7 @@ module Jekyll
     #   {% endkatex %}
     class Katex < Liquid::Block
       LOG_TOPIC = 'Katex Block:'
-      KATEX ||= ExecJS.compile(File.open(Jekyll::Katex::Configuration.js_path).read)
+      KATEX ||= Jekyll::Katex::KATEX_JS
 
       def initialize(tag_name, markup, tokens)
         super

data/lib/jekyll/tags/katex_math_mode.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'jekyll-katex/configuration'
+require 'jekyll-katex/katex_js'
+
+module Jekyll
+  module Tags
+    # Defines the custom Liquid tag for compile-time rendering of KaTeX math.
+    # This differs from the katex tag in that it allows use of `$` and `$$` fencing to mark math mode blocks similar to
+    # standard latex.
+    #   {% katexmm %}
+    #   This is a mixed environment where you can write text as normal but fence off latex math using `$`. Escape
+    #   using `\$`. For example.
+    #   $latex math with \$$
+    #   $$display mode latex$$
+    #   {% endkatexmm %}
+    class KatexMathMode < Liquid::Block
+      LOG_TOPIC = 'KatexMathMode:'
+      KATEX ||= Jekyll::Katex::KATEX_JS
+      LATEX_TOKEN_PATTERN = /(?<!\\)([$]{2}|[$]{1})(.+?)(?<!\\)\1/m
+
+      def initialize(tag_name, markup, tokens)
+        super
+        @markup = markup
+        @tokens = tokens
+        @display_mode_rendering = Jekyll::Katex::Configuration.global_rendering_options.merge(displayMode: true)
+        @inline_mode_rendering = Jekyll::Katex::Configuration.global_rendering_options.merge(displayMode: false)
+      end
+
+      def render(context)
+        enclosed_block = super
+        rendered_str = enclosed_block.to_s.gsub(LATEX_TOKEN_PATTERN) do |match|
+          display_mode = match.to_s.start_with? '$$'
+          rendering_options = display_mode ? @display_mode_rendering : @inline_mode_rendering
+          Jekyll.logger.debug LOG_TOPIC, "Rendering matched block - #{match}"
+          KATEX.call('katex.renderToString', Regexp.last_match(2), rendering_options)
+        end
+        # KaTeX should fix escaped `$` within fenced blocks, this addresses instances outside of math mode
+        rendered_str.to_s.gsub(/\\[$]/, '$').to_s
+      end
+    end
+  end
+end

data/lib/jekyll-katex/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'jekyll'
+require 'jekyll-katex/lib_root'
 
 module Jekyll
   module Katex

data/lib/jekyll-katex/katex_js.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'execjs'
+require 'jekyll-katex/configuration'
+
+# Holds reference to the katex.min.js lib
+module Jekyll
+  # Katex fast math rendering, see https://github.com/Khan/KaTeX
+  module Katex
+    KATEX_JS ||= ExecJS.compile(File.open(Jekyll::Katex::Configuration.js_path).read)
+  end
+end

data/lib/jekyll-katex/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Katex
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
   end
 end

data/lib/jekyll-katex.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
 require 'jekyll'
-
-require 'jekyll-katex/version'
-require 'jekyll-katex/lib_root'
 require 'jekyll/tags/katex'
+require 'jekyll/tags/katex_math_mode'
 
 Liquid::Template.register_tag('katex', Jekyll::Tags::Katex)
+Liquid::Template.register_tag('katexmm', Jekyll::Tags::KatexMathMode)

data/yarn.lock

@@ -5,9 +5,11 @@
 katex@^0.9.0:
   version "0.9.0"
   resolved "https://registry.yarnpkg.com/katex/-/katex-0.9.0.tgz#26a7d082c21d53725422d2d71da9b2d8455fbd4a"
+  integrity sha512-lp3x90LT1tDZBW2tjLheJ98wmRMRjUHwk4QpaswT9bhqoQZ+XA4cPcjcQBxgOQNwaOSt6ZeL/a6GKQ1of3LFxQ==
   dependencies:
     match-at "^0.1.1"
 
 match-at@^0.1.1:
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/match-at/-/match-at-0.1.1.tgz#25d040d291777704d5e6556bbb79230ec2de0540"
+  integrity sha512-h4Yd392z9mST+dzc+yjuybOGFNOZjmXIPKWjxBd1Bb23r4SmDOsk2NYCU2BMUBGbSpZqwVsZYNq26QS3xfaT3Q==

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-katex
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jerry Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-01 00:00:00.000000000 Z
+date: 2018-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -129,9 +129,11 @@ files:
 - lib/assets/js/katex.min.js
 - lib/jekyll-katex.rb
 - lib/jekyll-katex/configuration.rb
+- lib/jekyll-katex/katex_js.rb
 - lib/jekyll-katex/lib_root.rb
 - lib/jekyll-katex/version.rb
 - lib/jekyll/tags/katex.rb
+- lib/jekyll/tags/katex_math_mode.rb
 - package.json
 - yarn.lock
 homepage: https://github.com/linjer/jekyll-katex