RubyGems - jekyll-mathjax-csp - Versions diffs - 1.1.0 → 2.0.0 - Mend

jekyll-mathjax-csp 1.1.0 → 2.0.0

Files changed (5) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2eb60248118f9651e899564a7948241f0d53fbd3467880d53fbd2a449978436
-  data.tar.gz: 9bfcfe90f271fb0630c02604c222a4b0c591c061cbee6edccf685ce33dde8b7f
+  metadata.gz: 3cfec3c03b281adbf01ba53747ec25305c97542f8ed28c19dc1274f081c400ed
+  data.tar.gz: 96cb8d4012725a10c8d0b5e90cad63c7d2f7930180587d98221e4fa8c4d43085
 SHA512:
-  metadata.gz: a74cb169542c4160f95991190f8352cd6f30f3903afb76e64f96866a0d3f5a14ba7bb4429adcfb0bf68583fc7addfc2189071502895eb9b574a4a1778972c929
-  data.tar.gz: 970b4eeea9f8022e4bcd83f480773ec86552d688f12dd255aaf21a20c88d520c691944bfac5a40fbca259a8c3eb6a3719ba21c4d68dfe824f2d7e1e37b4191bb
+  metadata.gz: 9a77f77aba3d98d53a9742952d1df2403161ac5f77529577c283d878981fc173741fcf6c70657c2672b07b93d3ed251d1cd0699a96181cd82dad9959a518aa31
+  data.tar.gz: 6ae23704a48e987c4f55e5795e0d363f5a48d44f214f80be5b65811918f296bc2f20226ddb7be750078e0aae40167c6464a396dac4a8357a1509a2f9bebb47ac

data/README.md CHANGED Viewed

@@ -1,18 +1,18 @@
 # jekyll-mathjax-csp
-Render math on the server using [MathJax-node](https://github.com/mathjax/MathJax-node), while maintaining a strict [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) without `'unsafe-inline'`.
+Render math on the server using the [MathJax 3 node API](https://github.com/mathjax/MathJax-demos-node), while maintaining a strict [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) without `'unsafe-inline'`.
 While MathJax is well equipped to render beautiful math in a browser, letting it run in the client has two distinctive disadvantages: It is quite CPU-intensive and crucially relies on inline `style` attributes and elements. This Jekyll plugin aims to resolve both issues at once by rendering formulas to SVG images on the server, extracting all generated `style` attributes into a single `<style>` element in the head of the page and computing a hash over its content that can then be added as a CSP `style-src`.
-The plugin runs the output of Jekyll's markdown parser [kramdown](http://kramdown.gettalong.org/) through the CLI converter `mjpage` offered by the npm package [`mathjax-node-page`](https://github.com/pkra/mathjax-node-page) and thus behaves exactly as client-side MathJax in SVG rendering mode would.
+The plugin runs the output of Jekyll's markdown parser [kramdown](http://kramdown.gettalong.org/) through the [MathJax 3 node API](https://github.com/mathjax/MathJax-demos-node) and thus behaves exactly as client-side MathJax in SVG rendering mode would.
 ## Usage
-1. Install the npm package `mathjax-node-page` from your top-level Jekyll directory:
+1. Install the npm packages `mathjax-full` and `yargs` from your top-level Jekyll directory:
    ```bash
    npm init -f # only if you don't have a package.json yet
-   npm install mathjax-node-page@2.X
+   npm install mathjax-full yargs
    ```
 2. Install `jekyll-mathjax-csp`:
@@ -39,53 +39,29 @@ The plugin runs the output of Jekyll's markdown parser [kramdown](http://kramdow
 ## Dependencies
-* `mathjax-node-page` (npm): 2.0+
+* `mathjax-full` (npm): 3.0+
+* `yargs` (npm): 16.1.0+
 * `html-pipeline`: 2.3+
 * `jekyll`: 3.0+
 ## Configuration
-The following fields can be set in `_config.yml`; their default values are given in the sample below.
-```yaml
-mathjax_csp:
-  linebreaks: false
-  single_dollars: false
-  format: AsciiMath,TeX,MathML
-  font: TeX
-  semantics: false
-  notexthints: false
-  output: SVG
-  eqno: none
-  ex_size: 6
-  width: 100
-  extensions: ""
-  font_url: "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/fonts/HTML-CSS"
-  strip_css: false
-```
-'mathjax-node-page' adds a fixed inline stylesheet to every page containing math. If you want to serve this stylesheet as an external `.css`, you can advise the plugin to strip it from the output by adding the following lines to your `_config.yml`:
+MathJax adds a fixed inline stylesheet to every page containing math. If you want to serve this stylesheet as an external `.css`, you can advise the plugin to strip it from the output by adding the following lines to your `_config.yml`:
 ```yaml
 mathjax_csp:
   strip_css: true
 ```
-Configuration for 'mathjax-node-page' is also available:
-| Key              | Description                                                  | Default                                                      |
-| ---------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `linebreaks`     | Perform automatic line-breaking                              | `false`                                                      |
-| `single_dollars` | Allow single-dollar delimiters for inline math               | `false`                                                      |
-| `format`         | Input format(s) to look for                                  | `AsciiMath,TeX,MathML`                                       |
-| `font`           | Web font to use in SVG output                                | `TeX`                                                        |
-| `semantics`      | For TeX or Asciimath source and MathML output, add input in `<semantics>` tag | `false`                                                      |
-| `notexthints`    | For TeX input and MathML output, don't add TeX-specific classes | `false`                                                      |
-| `output`         | Output format: SVG, CommonHTML, or MML                       | `SVG`                                                        |
-| `eqno`           | Equation number style (none, AMS, or all)                    | `none`                                                       |
-| `ex_size`        | Ex-size, in pixels                                           | `6`                                                          |
-| `width`          | Width of equation container in `ex`. Used for line-breaking  | `100`                                                        |
-| `extensions`     | Extra MathJax extensions (e.g. `Safe,Tex/noUndefined`)       | `""`                                                         |
-| `font_url`       | URL to use for web fonts                                     | `https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/fonts/HTML-CSS` |
+Other configuration options for MathJax are also available:
+| Key              | Description                                    | Default |
+| ---------------- | ---------------------------------------------- | ------- |
+| `em_size`        | Em-size, in pixels                             | `12`    |
+| `ex_size`        | Ex-size, in pixels                             | `6`     |
+| `single_dollars` | Allow single-dollar delimiters for inline math | `false` |
+| `output`         | Output format: `SVG` or `CommonHTML`           | `SVG`   |
 ## Local testing
@@ -110,4 +86,4 @@ Note that this cannot be used with frame-ancestors, report-uri, or sandbox.
 ## License
-MIT
+MIT

data/bin/mathjaxify ADDED Viewed

@@ -0,0 +1,157 @@
+#! /usr/bin/env node
+// The MIT License (MIT)
+// =====================
+//
+// Copyright © 2018 Fabian Henneke
+//
+// Permission is hereby granted, free of charge, to any person
+// obtaining a copy of this software and associated documentation
+// files (the “Software”), to deal in the Software without
+// restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following
+// conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+// OTHER DEALINGS IN THE SOFTWARE.
+/*************************************************************************
+ *  Modified from MathJax-demos-node direct/tex2svg-page by Fabian Henneke
+ *
+ *  Original copyright and licensing information:
+ * ----------------------------------------------------------------------
+ *
+ *  Copyright (c) 2018 The MathJax Consortium
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+//
+//  Load the packages needed for MathJax
+//
+const {mathjax} = require('mathjax-full/js/mathjax.js');
+const {TeX} = require('mathjax-full/js/input/tex.js');
+const {SVG} = require('mathjax-full/js/output/svg.js');
+const {CHTML} = require('mathjax-full/js/output/chtml.js');
+const {liteAdaptor} = require('mathjax-full/js/adaptors/liteAdaptor.js');
+const {RegisterHTMLHandler} = require('mathjax-full/js/handlers/html.js');
+const {AssistiveMmlHandler} = require('mathjax-full/js/a11y/assistive-mml.js');
+const {AllPackages} = require('mathjax-full/js/input/tex/AllPackages.js');
+require('mathjax-full/js/util/entities/all.js');
+//
+//  Get the command-line arguments
+//
+var argv = require('yargs')
+    .demand(0).strict()
+    .usage('$0 [options] < input.json > output.json')
+    .options({
+        em: {
+            default: 12,
+            describe: 'em-size in pixels'
+        },
+        ex: {
+            default: 6,
+            describe: 'ex-size in pixels'
+        },
+        singleDollars: {
+            default: false,
+            type: 'boolean'
+        },
+        output: {
+            default: 'SVG',
+            choices: ['SVG', 'CommonHTML']
+        }
+    })
+    .argv;
+//
+//  Read input JSON from stdin
+//
+const inputDocs = JSON.parse(require('fs').readFileSync(0, 'utf8'));
+//
+//  Create DOM adaptor and register it for HTML documents
+//
+const adaptor = liteAdaptor({fontSize: argv.em});
+AssistiveMmlHandler(RegisterHTMLHandler(adaptor));
+//
+//  Create input and output jax and a document using them on the content from the HTML file
+//
+function getInput() {
+    const options = {packages: AllPackages};
+    if (argv.singleDollars) {
+        options.inlineMath = [['$', '$'], ['\\(', '\\)']]
+    }
+    return new TeX(options);
+}
+function getOutput() {
+    const options = {exFactor: argv.ex / argv.em};
+    switch (argv.output) {
+        case 'SVG':
+            return new SVG({...options, fontCache: 'global'});
+        case 'CommonHTML':
+            return new CHTML({...options, fontURL: 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2'});
+        default:
+            throw new Error('Unrecognized output format: ' + argv.output);
+    }
+}
+const outputDocs = {};
+// For each input path and HTML doc
+Object.keys(inputDocs).forEach((path) => {
+    console.error("mathjaxify:", path);
+    const inputHTML = inputDocs[path];
+    const html = mathjax.document(inputHTML, {InputJax: getInput(), OutputJax: getOutput()});
+    //
+    //  Typeset the document
+    //
+    html.render();
+    //
+    //  If no math was found on the page, remove the stylesheet and font cache (if any)
+    //
+    if (argv.output === "SVG" && html.math.toArray().length === 0) {
+        adaptor.remove(html.outputJax.svgStyles);
+        const cache = adaptor.elementById(adaptor.body(html.document), 'MJX-SVG-global-cache');
+        if (cache) adaptor.remove(cache);
+    }
+    //
+    //  Store the resulting HTML in the output
+    //
+    outputDocs[path] = adaptor.doctype(html.document)
+                        + "\n"
+                        + adaptor.outerHTML(adaptor.root(html.document));
+});
+// Write out all the documents in JSON format
+console.log(JSON.stringify(outputDocs));

data/lib/jekyll-mathjax-csp.rb CHANGED Viewed

@@ -1,4 +1,5 @@
-# Server-side, CSP-aware math rendering for Jekyll using mathjax-node-page
+# coding: utf-8
+# Server-side, CSP-aware math rendering for Jekyll using MathJax's node API
 #
 # The MIT License (MIT)
 # =====================
@@ -35,46 +36,34 @@ require "set"
 module Jekyll
-  # Run Jekyll documents through mathjax-node-page, transform style attributes into inline style
+  # Run Jekyll documents through MathJax's node engine, transform style attributes into inline style
   # tags and compute their hashes
   class Mathifier
-    MATH_TAG_REGEX = /<script[^>]*type="math\/tex/i
+    MATH_TAG_REGEX = /(<script[^>]*type="math\/tex|\\\[.*\\\]|\\\(.*\\\))/im
     FIELDS = {
-      "format" => "--format",
-      "font" => "--font",
-      "ouput" => "--output",
-      "equation_number" => "--eqno",
-      "output" => "--output",
-      "eqno" => "--eqno",
+      "em_size" => "--em",
       "ex_size" => "--ex",
-      "width" => "--width",
-      "extensions" => "--extensions",
-      "font_url" => "--fontURL"
-    }
-    FLAGS = {
-      "linebreaks" => "--linebreaks",
-      "single_dollars" => "--dollars",
-      "semantics" => "--semantics",
-      "notexthints" => "--notexthints"
+      "single_dollars" => "--singleDollars",
+      "output" => "--output",
     }
     class << self
       attr_accessor :csp_hashes
-      # Extract all style attributes from SVG elements and replace them by a new CSS class with a
-      # deterministic name
+      # Extract all style attributes from SVG and container elements and replace them with a new
+      # CSS class with a deterministic name
       def extractStyleAttributes(parsed_doc)
         style_attributes = {}
-        svg_tags = parsed_doc.css("svg[style]")
-        for svg_tag in svg_tags do
-          style_attribute = svg_tag["style"]
+        styled_tags = parsed_doc.css("svg[style],mjx-container[style]")
+        for styled_tag in styled_tags do
+          style_attribute = styled_tag["style"]
           digest = Digest::MD5.hexdigest(style_attribute)[0..15]
           style_attributes[digest] = style_attribute
           digest_class = "mathjax-inline-#{digest}"
-          svg_tag["class"] = "#{svg_tag["class"] || ""} #{digest_class}"
-          svg_tag.remove_attribute("style")
+          styled_tag["class"] = "#{styled_tag["class"] || ""} #{digest_class}"
+          styled_tag.remove_attribute("style")
         end
         return style_attributes
       end
@@ -96,71 +85,73 @@ module Jekyll
         hashStyleTag(style_tag)
       end
-      # Run mathjax-node-page on a String containing an HTML doc
-      def run_mjpage(config, output)
+      # Run the MathJax node backend on a JSON input containing an file: HTML map
+      def run_mathjaxify(config, input)
         mathified = ""
         exit_status = 0
-        command = "node_modules/mathjax-node-page/bin/mjpage"
-        FIELDS.each do |name, flag|
-          unless config[name].nil?
-            command << " " << flag << " " << config[name].to_s
-          end
-        end
+        command = "node #{Gem.bin_path("jekyll-mathjax-csp", "mathjaxify")}"
-        FLAGS.each do |name, flag|
+        FIELDS.each do |name, flag|
           unless config[name].nil?
-            command << " " << flag
+            if [true, false].include? config[name]
+              command << " " << flag
+            else
+              command << " " << flag << " " << config[name].to_s
+            end
           end
         end
-        begin
-          Open3.popen2(command) {|i,o,t|
-            i.print output
-            i.close
-            o.each {|line|
-              mathified.concat(line)
-            }
-            exit_status = t.value
-          }
-          return mathified unless exit_status != 0
-          Jekyll.logger.abort_with "mathjax_csp:", "'node_modules/mathjax-node-page/mjpage' not found"
-        rescue
-          Jekyll.logger.abort_with "mathjax_csp:", "Failed to execute 'node_modules/mathjax-node-page/mjpage'"
-        end
+        node_path = Dir.pwd + "/node_modules"
+        Jekyll.logger.info "mathjax_csp:", "starting node #{command}"
+        mathified, status = Open3.capture2({"NODE_PATH" => node_path}, command, stdin_data: input)
+        return mathified unless status != 0
+        Jekyll.logger.abort_with "mathjax_csp:", "Failed to execute 'bin/mathjaxify'"
       end
-      # Render math
-      def mathify(doc, config)
-        return unless MATH_TAG_REGEX.match?(doc.output)
-        Jekyll.logger.info "Rendering math:", doc.relative_path
-        parsed_doc = Nokogiri::HTML::Document.parse(doc.output)
-        # Ensure that all styles we pick up weren't present before mjpage ran
-        unless parsed_doc.css("svg[style]").empty?()
-          Jekyll.logger.error "mathjax_csp:", "Inline style on <svg> element present before running mjpage"
-          Jekyll.logger.abort_with "", "due to a misconfiguration or server-side style injection."
+      # Render math in batch for all documents
+      def mathify(docs, config)
+        docs = docs.select { |d| Jekyll::Mathifier.mathable?(d) } # can be mathified?
+                   .select { |d| MATH_TAG_REGEX.match?(d.output) } # needs mathifying?
+                   .reduce({}) { |h, d| h.merge!(d.path => d) } # use #path to identify a doc
+        return if docs.empty?
+        Jekyll.logger.info "mathjax_csp:", "Found #{docs.length} documents."
+        docs.each do |path, doc|
+          Jekyll.logger.info "Checking math:", path
+          parsed_doc = Nokogiri::HTML::Document.parse(doc.output)
+          # Ensure that all styles we pick up weren't present before MathJax ran
+          unless parsed_doc.css("svg[style],mjx-container[style]").empty?
+            Jekyll.logger.error "mathjax_csp:", "Inline style on <svg> or <mjx-container> element present"
+            Jekyll.logger.error "", "before rendering math due to misconfiguration or server-side"
+            Jekyll.logger.abort_with "", "style injection."
+          end
         end
-        mjpage_output = run_mjpage(config, doc.output)
-        parsed_doc = Nokogiri::HTML::Document.parse(mjpage_output)
-        last_child = parsed_doc.at_css("head").last_element_child()
-        if last_child.name == "style"
-          # Set strip_css to true in _config.yml if you load the styles mjpage adds to the head
-          # from an external *.css file
-          if config["strip_css"]
-            Jekyll.logger.info "", "Remember to <link> in external stylesheet!"
-            last_child.remove
-          else
-            hashStyleTag(last_child)
+        mathjaxify_input = docs.reduce({}) { |h, (path, doc)| h.merge!(path => doc.output) }
+                               .to_json
+        mathified_docs = JSON.parse(run_mathjaxify(config, mathjaxify_input))
+        mathified_docs.each do |path, mathified_html|
+          parsed_doc = Nokogiri::HTML::Document.parse(mathified_html)
+          last_child = parsed_doc.at_css("head").last_element_child()
+          if last_child.name == "style"
+            # Set strip_css to true in _config.yml if you load the styles MathJax adds to the head
+            # from an external *.css file
+            if config["strip_css"]
+              Jekyll.logger.info "", "Remember to <link> in external stylesheet!"
+              last_child.remove
+            else
+              hashStyleTag(last_child)
+            end
           end
+          style_attributes = extractStyleAttributes(parsed_doc)
+          compileStyleElement(parsed_doc, style_attributes)
+          docs[path].output = parsed_doc.to_html
         end
-        style_attributes = extractStyleAttributes(parsed_doc)
-        compileStyleElement(parsed_doc, style_attributes)
-        doc.output = parsed_doc.to_html
+        Jekyll.logger.info "mathjax_csp:", "Mathified #{mathified_docs.length} documents."
       end
       def mathable?(doc)
@@ -215,12 +206,10 @@ Jekyll::Hooks.register [:documents, :pages], :pre_render do |doc|
   Jekyll::MathJaxSourcesTag.unrendered_docs[doc.relative_path] = doc.content
 end
-# Replace math blocks with SVG renderings using mathjax-node-page and collect inline styles in a
+# Replace math blocks with SVG renderings using mathjaxify and collect inline styles in a
 # single <style> element
-Jekyll::Hooks.register [:documents, :pages], :post_render do |doc|
-  if Jekyll::Mathifier.mathable?(doc)
-    Jekyll::Mathifier.mathify(doc, doc.site.config["mathjax_csp"] || {})
-  end
+Jekyll::Hooks.register :site, :post_render do |site|
+  Jekyll::Mathifier.mathify(site.posts.docs + site.pages, site.config["mathjax_csp"] || {})
 end
 # Run over all documents with {% mathjax_sources %} Liquid tags again and insert the list of CSP

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-mathjax-csp
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
-- Fabian Henneke
+- Fabian Meumertzheim
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline
@@ -16,38 +16,46 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Server-side MathJax rendering for Jekyll with a strict CSP
-email: fabian@henneke.me
-executables: []
+email: fabian@meumertzhe.im
+executables:
+- mathjaxify
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
 - README.md
+- bin/mathjaxify
 - lib/jekyll-mathjax-csp.rb
-homepage: https://github.com/FabianHenneke/jekyll-mathjax-csp
+homepage: https://github.com/fmeum/jekyll-mathjax-csp
 licenses:
 - MIT
 metadata: {}
@@ -66,8 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Server-side MathJax & CSP for Jekyll