jekyll-katex 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 245c842caca588d55ca898b3795be4bb88d18bb363f992232dbf4c6003dac92b
-  data.tar.gz: 37da7ae6d2de974ef560c703004099536b473d0f02227f1e798593228d1f7147
+  metadata.gz: 97204d37eda949470ffafeaedfc8341aabf81615f48f97a8ac0f5d4c0dd4fa7c
+  data.tar.gz: bffedf65d7f5fd45b8ed2d19edb1f6da9c33bc2b5efc3782d75edd541797601f
 SHA512:
-  metadata.gz: 37ee1e20e43fae43d0c9d08f8552677226409a5b32ebd7bf4fdfaff592fc98384f5c753063077b2998b0bf68b1b24bdb9f0b4ec34f410d38a80fb5435ff9dc8b
-  data.tar.gz: f32d42946fe223aeb0b3a9f04fc6c65d75dc212bbdd5a2bdf21ec44ab625b20fa1dade256e1b1c4e4b2db71c86b4ab77c0cf5881de4b4dc6aab5f091ac58ecb3
+  metadata.gz: 3e86b908ba3bc9695603facd44919aaf8844b58a5554b3577c94b1728364fafd50cc6206c5c870d26c5f4c32fc5cc3dbab27222ab0c34b994dfc4b7c1b188b7a
+  data.tar.gz: 39309615a67795675f4dc9e3ab4138d1a9822eeafb9d892a24ee4ff0c072e0b556722c4e4acfbb33197f6b976527550881dea40e09ea65f34f1e04756712ae93

data/.rubocop.yml

@@ -0,0 +1,6 @@
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Max: 60

data/README.md

@@ -6,35 +6,49 @@ KaTeX is a library for rending math on the web using LaTeX, similar to MathJax.
 KaTeX differs from MathJax in that it displays faster rendering speed and renders to pure HTML rather than PNGs.
 There are various resources in benchmarking and comparing their performance, for more info, [start here](https://khan.github.io/KaTeX/).
 
-Comes packaged with KaTeX `^0.8.3` but 
+Comes packaged with KaTeX `0.9.0` but you can specify a different version in your Jekyll `_config.yml` (see below).
 
 ## Installation
 
 ### Bundler (recommended)
 
-In your Jekyll project, add `jekyll-katex` to your `gems.rb`/`Gemfile` plugin block:
+1. In your Jekyll project, add the plugin to your `_config.yml`, e.g.:
 
-```ruby
-group :jekyll_plugins do
-  gem 'jekyll-katex'
-end
-```
+    ```yaml
+    plugins:
+      - jekyll-katex
+    ```
+
+2. Add `jekyll-katex` to your `gems.rb`/`Gemfile` plugin block:
+
+    ```ruby
+    group :jekyll_plugins do
+      gem 'jekyll-katex'
+    end
+    ```
 
-Once done, execute `bundle install`.
+    Once done, execute `bundle install`. For more information, see [here](https://jekyllrb.com/docs/plugins/).
 
-For alternative install methods, see [here](https://jekyllrb.com/docs/plugins/).
+3. Add KaTeX CSS and Fonts. Follow the installation instructions on the [KaTeX README](https://github.com/Khan/KaTeX).
+    You can skip including the `.js` file unless you want to do client-side in-browser rendering, as well.
 
-### Config
+    Put the following (adjusting for your version) in your page headers:
 
-Once plugin is included in your project, follow the installation instructions on the [KaTeX](https://github.com/Khan/KaTeX) README for the CSS and font files.
-You can skip including the `.js` file unless you want to do client-side in-browser rendering as well.
+    ```html
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.10.0-alpha/dist/katex.min.css" integrity="sha384-BTL0nVi8DnMrNdMQZG1Ww6yasK9ZGnUxL1ZWukXQ7fygA1py52yPp9W4wrR00VML" crossorigin="anonymous">
+    ```
 
-#### tl;dr
+## Configuration
 
-Put the following in your page headers:
+Supported configuration values, shown with default values:
 
-```html
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.8.3/katex.min.css">
+```yml
+katex:
+  js_path: "{{ Gem::lib_path }}/assets/js"  # Path used to search for katex.min.js
+  rendering_options:
+    # Default KaTeX rendering options. See https://github.com/Khan/KaTeX#rendering-options
+    throw_error: true                       # throwOnError - set to false if you want rendering to output error as text rather than a build error
+    error_color: "#cc0000"                  # errorColor
 ```
 
 ## Usage
@@ -57,16 +71,11 @@ c = \pm\sqrt{a^2 + b^2}
 
 ## Development
 
-### Getting Started
-
 ```bash
-./bin/setup.sh
+$ bundle install
+$ rake build
 ```
 
-### TODOs
-
-1. Better stand-alone packaging of KaTeX - specific KaTeX version shouldn't need to depend on this plugin
-
 ## Contributing
 
 Feel free to open issues and pull requests.

data/Rakefile

@@ -1,4 +1,6 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 
 task default: :build
 
@@ -7,10 +9,16 @@ task :js_i do
   cp 'node_modules/katex/dist/katex.min.js', 'lib/assets/js/katex.min.js'
 end
 
-task build: [:js_i] do
+task build: %i[js_i] do
   sh 'gem', 'build', 'jekyll-katex.gemspec'
 end
 
-task push: [:build] do
-  sh 'gem', 'push', "jekyll-katex-#{Jekyll::Katex::VERSION}.gem"
+task clobber: [:clean] do
+  rm_rf Rake::FileList.new('*.gem')
+end
+
+task :stylecheck do
+  sh 'bundle', 'exec', 'rubocop', '--auto-correct'
 end
+
+task release: :stylecheck

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "jekyll/katex"
+require 'bundler/setup'
+require 'jekyll-katex'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "jekyll/katex"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/gems.locked

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-katex (0.1.4)
+    jekyll-katex (0.2.0)
       execjs (~> 2.7)
       jekyll (~> 3.8)
 
@@ -14,17 +14,18 @@ GEM
     colorator (1.1.0)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
+    docile (1.3.1)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     eventmachine (1.2.7)
     execjs (2.7.0)
-    ffi (1.9.23)
+    ffi (1.9.25)
     forwardable-extended (2.6.0)
     http_parser.rb (0.6.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.2)
+    jekyll (3.8.3)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -41,6 +42,7 @@ GEM
       sass (~> 3.4)
     jekyll-watch (2.0.0)
       listen (~> 3.0)
+    json (2.1.0)
     kramdown (1.17.0)
     liquid (4.0.0)
     listen (3.1.5)
@@ -55,9 +57,8 @@ GEM
       forwardable-extended (~> 2.6)
     powerpack (0.1.1)
     public_suffix (3.0.2)
-    rainbow (2.2.2)
-      rake
-    rake (10.5.0)
+    rainbow (3.0.0)
+    rake (12.3.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
@@ -75,11 +76,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    rubocop (0.50.0)
+    rubocop (0.56.0)
       parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
+      parser (>= 2.5)
       powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
@@ -90,7 +91,12 @@ GEM
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    unicode-display_width (1.3.3)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
@@ -98,9 +104,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   jekyll-katex!
-  rake (~> 10.5)
+  rake (~> 12.3)
   rspec (~> 3.7)
-  rubocop (~> 0.50.0)
+  rubocop (~> 0.56.0)
+  simplecov (~> 0.16)
 
 BUNDLED WITH
    1.16.2

data/gems.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in jekyll-katex.gemspec

data/jekyll-katex.gemspec

@@ -1,8 +1,10 @@
-# encoding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'jekyll/katex/version'
+require 'jekyll-katex/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'jekyll-katex'
@@ -10,8 +12,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jerry Lin']
   spec.email         = 'linjer@gmail.com'
 
-  spec.summary       = %q{Jekyll plugin for easy KaTeX math server-side rendering.}
-  spec.description   = %q{Adds a liquid tag you can use to do server-side rendering of latex math using KaTeX}
+  spec.summary       = 'Jekyll plugin for easy KaTeX math server-side rendering.'
+  spec.description   = 'Adds a liquid tag you can use to do server-side rendering of latex math using KaTeX'
   spec.homepage      = 'https://github.com/linjer/jekyll-katex'
   spec.license       = 'MIT'
 
@@ -24,17 +26,18 @@ Gem::Specification.new do |spec|
   # end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } <<
-  spec.bindir        = 'bin'
+                       spec.bindir = 'bin'
   spec.executables   = []
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3.5'
+  spec.required_ruby_version = '>= 2.5.1'
 
-  spec.add_runtime_dependency 'jekyll', '~> 3.8'
   spec.add_runtime_dependency 'execjs', '~> 2.7'
+  spec.add_runtime_dependency 'jekyll', '~> 3.8'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.7'
   spec.add_development_dependency 'rubocop', '~> 0.56.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
 end

data/lib/{jekyll/katex.rb → jekyll-katex.rb}

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

data/lib/jekyll-katex/configuration.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+
+module Jekyll
+  module Katex
+    # For holding configuration values specific to the jekyll-katex plugin
+    class Configuration
+      LOG_TOPIC = 'Katex Configuration:'
+      CONFIG_DEFAULTS = {
+        js_filename: 'katex.min.js',
+        js_path: File.join(Jekyll::Katex::LIB_ROOT, 'assets/js/'),
+        rendering_options: {
+          throw_error: true,
+          error_color: '#cc0000'
+        }
+      }.freeze
+
+      JEKYLL_CONFIG = Jekyll.configuration['katex']
+
+      def self.js_path
+        js_filename = JEKYLL_CONFIG['js_filename'] || CONFIG_DEFAULTS[:js_filename]
+        js_path = JEKYLL_CONFIG['js_path'] || CONFIG_DEFAULTS[:js_path]
+
+        katex_js = Dir.glob("#{js_path}/**/#{js_filename}").first
+        if katex_js.nil?
+          raise RuntimeError, 'Could not find KaTeX javascript file using provided configuration.'
+        end
+        Jekyll.logger.info LOG_TOPIC, "Found KaTeX js at: #{katex_js}"
+        katex_js
+      end
+
+      def self.global_rendering_options
+        {
+          throwOnError: JEKYLL_CONFIG['throw_error'] || CONFIG_DEFAULTS[:throw_error],
+          errorColor: JEKYLL_CONFIG['error_color'] || CONFIG_DEFAULTS[:error_color]
+        }
+      end
+    end
+  end
+end

data/lib/jekyll-katex/lib_root.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Katex
+    LIB_ROOT = (File.expand_path '..', __dir__).freeze
+  end
+end

data/lib/jekyll-katex/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Katex
+    VERSION = '0.2.0'
+  end
+end

data/lib/jekyll/tags/katex.rb

@@ -1,25 +1,30 @@
+# frozen_string_literal: true
+
 require 'execjs'
+require 'jekyll-katex/configuration'
 
 module Jekyll
   module Tags
+    # Defines the custom Liquid tag for compile-time rendering of KaTeX math
+    #   {% katex %}
+    #   <latex math>
+    #   {% endkatex %}
     class Katex < Liquid::Block
-
-      KATEX_JS_PATH = File.join(Jekyll::Katex::LIB_ROOT, 'assets/js/katex.min.js')
+      LOG_TOPIC = 'Katex Block:'
+      KATEX ||= ExecJS.compile(File.open(Jekyll::Katex::Configuration.js_path).read)
 
       def initialize(tag_name, markup, tokens)
         super
-        @tokens = tokens
         @markup = markup
-
+        @tokens = tokens
         @display = markup.include? 'display'
-        @katex = ExecJS.compile(open(KATEX_JS_PATH).read)
       end
 
       def render(context)
         latex_source = super
-        @katex.call("katex.renderToString", latex_source, displayMode: @display)
+        rendering_options = Jekyll::Katex::Configuration.global_rendering_options.merge({ displayMode: @display })
+        KATEX.call('katex.renderToString', latex_source, rendering_options)
       end
     end
   end
 end
-2

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-katex
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Jerry Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2018-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: execjs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: execjs
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.56.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 description: Adds a liquid tag you can use to do server-side rendering of latex math
   using KaTeX
 email: linjer@gmail.com
@@ -102,20 +116,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
-- bin/setup.sh
 - gems.locked
 - gems.rb
 - jekyll-katex.gemspec
 - lib/assets/js/katex.min.js
-- lib/jekyll/katex.rb
-- lib/jekyll/katex/lib_root.rb
-- lib/jekyll/katex/version.rb
+- lib/jekyll-katex.rb
+- lib/jekyll-katex/configuration.rb
+- lib/jekyll-katex/lib_root.rb
+- lib/jekyll-katex/version.rb
 - lib/jekyll/tags/katex.rb
 - package.json
 - yarn.lock
@@ -131,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.5
+      version: 2.5.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/bin/setup.sh

@@ -1,7 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-rake katex_npm_i

data/lib/jekyll/katex/lib_root.rb

@@ -1,5 +0,0 @@
-module Jekyll
-  module Katex
-    LIB_ROOT = (File.expand_path '../../../', __FILE__).freeze
-  end
-end

data/lib/jekyll/katex/version.rb

@@ -1,5 +0,0 @@
-module Jekyll
-  module Katex
-    VERSION = '0.1.4'.freeze
-  end
-end