jekyll-t4j 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a1870ef42a1f2b51f55427bf9fc304e59224e0d473c9f1e0c43297ad2347709
-  data.tar.gz: 47330b060c44e1850c8691d2d88e302483c4069bf166b6f9dd4720b92170275b
+  metadata.gz: '08b199ca229a735a5862598c3833f1ca8c4643db6458fb24e1575604df8196aa'
+  data.tar.gz: aeb6470ab96afd7e12008946f568804c36fb44d42350cec3d5d3f20728b86401
 SHA512:
-  metadata.gz: b0842f23b676c35dfdbca726b144c243c0331d56200833af4e47c61210a5b833d0e86cd02cfd022f34b69b0af24272d46630e50521da98125343640115c22c66
-  data.tar.gz: 16d051b87d412c97fa69ed6222aadd4367506733b39963ccd91896f15a7eb8874b761bdd3db3bce4c2a3c1d8cc0e6445c5039eba1c14c2fe67d2e430dc3e2e5a
+  metadata.gz: eff915fbdffe8b6942226ef1dcfc39068fd89d5fd6fc51469844b7793af7804304f41249a5f02e11d2427fc8b9d5fc44c51bd6641ec449f112daaeb0e3e15a18
+  data.tar.gz: 5e6f3859887cca6604359dcc8341279f18b50d877815f87d7dc14e0310219c70a9b51d572c2ce1df1dc7b83aaad823a0745400859520e9e7ceeb9593d26fda4e

data/README.md

@@ -3,13 +3,16 @@
 jekyll-t4j is a Jekyll plugin providing (nearly) full support of LaTeX.
 
 - **Comprehensive**: support almost all packages, including tikz, chemfig, etc.
-- **Fast**: employ KaTeX to boost speed. Use cache, precompiled preamble, bulk rendering.
+- **Highly optimized**: employ KaTeX to boost speed. Use cache, precompiled preamble, bulk rendering.
 - **Server side rendering**: all stuffs are done in server.
 
 T4J integrates Jekyll with your local TeX distribution, so you need to have either [MikTeX](https://miktex.org/) or [TeX Live](https://tug.org/texlive/) installed.
 
 Feel free to write any LaTeX! 🎉
 
+> **Warning**
+> T4J now is in rapid development, it's pretty unstable. So don't forget to check and update frequently.
+
 ## Getting Started
 
 Let's start by a simple instance, write a post `2023-02-04-hello-latex.md` and fill it with:

data/lib/jekyll-t4j/engine/katex.rb

@@ -1,28 +1,41 @@
 # frozen_string_literal: true
 
-require "execjs"
+require "duktape"
 
 module Jekyll::T4J
     module Engine
         KATEX_VERSION = "0.16.4"
 
-        @@_katex_js_ = nil
+        @@_katex_ctx_ = nil
 
         def self.setup_katex
-            if not @@_katex_js_ then
+            if not @@_katex_ctx_ then
                 src = File.read(File.join(__dir__, "katex.js"))
                 src << File.read(File.join(__dir__, "katex.mhchem.js")) if Jekyll::T4J.cfg_pkgs.include?("mhchem")
 
-                @@_katex_js_ = ExecJS.runtime.compile(src)
+                @@_katex_ctx_ = Duktape::Context.new
+                @@_katex_ctx_.exec_string(src)
             end
         end
 
-        def self.katex_raw(snippet, options = nil)
-            snippet = split_snippet(snippet)
-            options = {} unless options
-            options[:displayMode] = snippet[1]
+        def self.katex_raw(snippet)
+            begin
+                @@_katex_ctx_.call_prop(["katex", "renderToString"], snippet.code_in,
+                    {
+                        displayMode: snippet.display_mode?,
+                        output: "mathml",
+                        strict: true
+                    }
+                )[20..-8]
+            rescue
+                nil
+            end
+        end
 
-            @@_katex_js_.call("katex.renderToString", snippet[0], options)
+        def self.katex_raw_bulk(snippets)
+            snippets.map do |snippet|
+                katex_raw(snippet) # TODO: parallel
+            end
         end
     end
 end

data/lib/jekyll-t4j/engine.rb

@@ -7,35 +7,30 @@ unless system("latex -version", [:out, :err] => File::NULL)
 end
 
 require "open3"
-require "jekyll/cache"
 
-require "jekyll-t4j/engine/dvisvgm"
 require "jekyll-t4j/engine/katex"
+require "jekyll-t4j/engine/dvisvgm"
 
 module Jekyll::T4J
     module Engine
-        @@cache_katex = Jekyll::Cache.new "Jekyll::T4J::Katex"
-        @@cache_dvisvgm = Jekyll::Cache.new "Jekyll::T4J::Dvisvgm"
-
-        @@header = <<~HD
-            <link rel=\"stylesheet\" href=\"https://unpkg.com/katex@#{KATEX_VERSION}/dist/katex.min.css\">
-            <style>
-                .katex-ext-d {
-                    border-radius: 0px;
-                    display: block;
-                    margin: 5px auto;
-                }
-                .katex-ext-i {
-                    border-radius: 0px;
-                    display: inline;
-                    vertical-align: middle;
-                }
-            </style>
-        HD
-        @@header.freeze
+        @@cache_katex = Jekyll::Cache.new "Jekyll-T4J::Katex"
+        @@cache_dvisvgm = Jekyll::Cache.new "Jekyll-T4J::Dvisvgm"
 
         def self.header
-            @@header
+            <<~HD
+                <script>
+                    document.addEventListener("DOMContentLoaded", () => {
+                        let z = document.body.getElementsByTagName("include")
+                        for (let i = 0; i < z.length; ++i) {
+                            let elmnt = z[i]
+                            let xhttp = new XMLHttpRequest()
+                            xhttp.onreadystatechange = function() { elmnt.innerHTML = this.responseText }
+                            xhttp.open("GET", elmnt.getAttribute("src"), true)
+                            xhttp.send()
+                        }
+                    })
+                </script>
+            HD
         end
 
         def self.setup
@@ -44,95 +39,82 @@ module Jekyll::T4J
         end
 
         def self.render(snippets, merger)
-            gen = ->(svg_data, displayMode) {
-                "<img src=\"#{merger.(svg_data, ".svg")}\" class=\"#{
-                    displayMode ? "katex-ext-d" : "katex-ext-i"
-                }\" style=\"height:#{
-                    (svg_data[/height='(\S+?)pt'/, 1].to_f * 0.1).to_s[/\d+\.\d{1,4}/]
-                }em\">"
+            gen_svg = ->(svg, displayMode) {
+                "<embed src=\"#{merger.(svg, ".svg")}\" style=\"height:#{
+                    (svg[/height='(\S+?)pt'/, 1].to_f * 0.1).round(4)
+                }em;#{
+                    displayMode ? "display:block;margin:auto" : "display:inline;vertical-align:middle"
+                }\">"
             }
-
-            # normalize 'snippets'
-            snippets.map! {|snippet|
-                if not snippet.start_with?("\\") then
-                    s = split_snippet(snippet)
-                    snippet = s[1] ? "\\[#{s[0]}\\]" : "\\(#{s[0]}\\)"
-                end
-
-                snippet
+            gen_mathml = ->(mathml) {
+                "<include src=\"#{merger.(mathml, ".xml")}\"></include>"
             }
 
-            # fill 'snippets' with katex and cached dvisvgm
-            unset = []
-            uncached = {}
-            snippets.each_index {|i|
-                s = snippets[i]
-                r = @@cache_katex.getset(s) {
-                    begin
-                        katex_raw(s, {strict: true})
-                    rescue
-                        "NIL"
-                    end
-                }
+            # 'snippets' << caches
+            uncached = {} #act as hash set
+            snippets.each_with_index do |s, i|
+                r = nil
 
-                if r == "NIL" then
+                begin
+                    r = gen_mathml.(@@cache_katex[s.source])
+                rescue
                     begin
-                        r = gen.(@@cache_dvisvgm[Jekyll::T4J.cfg_pkgs + s], is_display_mode?(s))
+                        r = gen_svg.(@@cache_dvisvgm[Jekyll::T4J.cfg_pkgs + s.source], s.display_mode?)
                     rescue
                         uncached[s] = nil
-                        unset << i
-                        r = s
                     end
                 end
 
-                snippets[i] = r
-            }
+                snippets[i] = r if r
+            end
+
+            # finish if no 'uncached' found
+            return if uncached.empty?
+            uncached = uncached.keys
+
+            # otherwise render 'uncached' with katex and cache them
+            katex_raw_bulk(uncached).each_with_index do |result, i|
+                @@cache_katex[uncached[i].source] = result if result
+            end
+
+            # 'snippets' << rendering results
+            uncached = {} #act as hash set again
+            snippets.each_with_index do |s, i|
+                next if !s.is_a?(Snippet)
 
-            # render 'uncached'
-            if not uncached.empty? then
-                # bulk render 'uncached'
                 begin
-                    uncached_snippets = uncached.keys
-                    rendered = dvisvgm_raw_bulk(uncached_snippets)
-                    rendered.each_index {|i| uncached[uncached_snippets[i]] = rendered[i]}
+                    snippets[i] = gen_mathml.(@@cache_katex[s.source])
+                rescue
+                    uncached[s] = nil
                 end
+            end
 
-                # flush 'uncached' to 'snippets' and cache them
-                unset.each {|i|
-                    s = snippets[i]
-                    r = uncached[s]
+            # finish if no 'uncached' found
+            return if uncached.empty?
+            uncached = uncached.keys
 
-                    snippets[i] = gen.(r, is_display_mode?(s))
-                    @@cache_dvisvgm[Jekyll::T4J.cfg_pkgs + s] = r
-                }
+            # otherwise render 'uncached' with dvisvgm and cache them
+            dvisvgm_raw_bulk(uncached).each_with_index do |result, i|
+                @@cache_dvisvgm[Jekyll::T4J.cfg_pkgs + uncached[i].source] = result
             end
-        end
 
-        def self.shell(cmd, pwd, times = 1)
-            while true do
-                break if times <= 0
-                times -= 1
+            # 'snippets' << rendering results
+            snippets.each_with_index do |s, i|
+                next if !s.is_a?(Snippet)
 
-                log, s = Open3.capture2e(cmd, :chdir => pwd) # TODO: even the quickest 'dvisvgm' cost at least 0.3s in my laptop
-                raise log if not s.success?
+                begin
+                    snippets[i] = gen_svg.(@@cache_dvisvgm[Jekyll::T4J.cfg_pkgs + s.source], s.display_mode?)
+                rescue
+                    # impossible!
+                end
             end
         end
 
-        def self.is_display_mode?(snippet)
-            snippet.start_with?("\\[") or snippet.start_with?("$$")
-        end
-
-        def self.split_snippet(snippet)
-            displayMode = false
-            range = 2..-3
-
-            if snippet.start_with?("\\[") or snippet.start_with?("$$") then
-                displayMode = true
-            elsif snippet.start_with?("$") then
-                range = 1..-2
+        def self.shell(cmd, pwd, n = 1)
+            n.times do
+                log, s = Open3.capture2e(cmd, :chdir => pwd) # TODO: even the quickest 'dvisvgm' cost at least 0.3s in my laptop
+                raise log if not s.success?
             end
-
-            [snippet[range], displayMode]
         end
     end
 end

data/lib/jekyll-t4j/merger.rb

@@ -20,10 +20,10 @@ module Jekyll::T4J
 
         # write external files and clean up
         Jekyll::Hooks.register :site, :post_write, priority: Jekyll::Hooks::PRIORITY_MAP[:low] do |site|
-            @@table.each {|filedata, request|
+            @@table.each do |filedata, request|
                 basename = request[0]
                 request[1].each {|extname| File.write(File.join(site.dest, basename + extname), filedata)}
-            }
+            end
 
             @@table.clear
         end

data/lib/jekyll-t4j/renderer.rb

@@ -82,16 +82,16 @@ module Jekyll::T4J
         docs = []
 
         # collect tex snippets
-        site.each_site_file {|f|
+        site.each_site_file do |f|
             next if f.is_a?(Jekyll::StaticFile)
             next if f.is_a?(Jekyll::Page) and not f.html?
 
             parts = extract(f.output)
             if parts.size > 1 then #'f' has tex snippet(s)
-                parts.each {|part| snippets << CGI::unescapeHTML(part[0]) if part[1]} # TODO: a subtle bug about unescaping HTML
+                parts.each {|part| snippets << Jekyll::T4J::Snippet.new(CGI::unescapeHTML part[0]) if part[1]}
                 docs << [f, parts]
             end
-        }
+        end
 
         # render 'snippets'
         Jekyll::T4J::Engine.render(snippets, ->(data, extname) {Jekyll::T4J::Merger.ask_for_merge(data, extname)})

data/lib/jekyll-t4j/snippet.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Jekyll::T4J
+    class Snippet
+        @is_display_mode
+        @source
+        @code_in
+
+        attr_reader :source, :code_in
+
+        def initialize(raw)
+            @is_display_mode = raw.start_with?("\\[") or raw.start_with?("$$")
+
+            # extract the code inside and minimize it
+            @code_in = raw[(display_mode? or raw.start_with?("\\")) ? (2..-3) : (1..-2)]
+            @code_in.strip! # TODO: minimize code
+            @code_in.freeze
+
+            # create minimized source
+            @source = display_mode? ? "\\[#{code_in}\\]" : "\\(#{code_in}\\)"
+            @source.freeze
+
+            # we are immutable
+            freeze
+        end
+
+        def display_mode?
+            @is_display_mode
+        end
+
+        def hash
+            source.hash
+        end
+
+        def ==(other)
+            self.class === other and source == other.source
+        end
+
+        alias to_s source
+        alias eql? ==
+    end
+end

data/lib/jekyll-t4j/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
     module T4J
-        VERSION = "0.4.0"
+        VERSION = "0.5.0"
     end
 end

data/lib/jekyll-t4j.rb

@@ -14,6 +14,7 @@ module Jekyll::T4J
     # initialize plugin
     Jekyll::Hooks.register :site, :after_init do |site|
         Jekyll.logger.info "Initializing T4J..."
+        t0 = Time.now
 
         cfg = site.config["t4j"]
         if cfg and (cfg = cfg["packages"]) then
@@ -30,9 +31,11 @@ module Jekyll::T4J
         end
 
         Jekyll::T4J::Engine.setup
+        Jekyll.logger.info "", "done in #{(Time.now - t0).round(3)} seconds."
     end
 end
 
+require "jekyll-t4j/snippet"
 require "jekyll-t4j/merger"
 require "jekyll-t4j/engine"
 require "jekyll-t4j/renderer"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-t4j
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - crow02531
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -25,20 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: execjs
+  name: duktape
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
-description: "        A Jekyll plugin providing (nearly) full support of LaTeX.\n"
+        version: '2.7'
+description: "        An optimized Jekyll plugin providing (nearly) full support of
+  LaTeX.\n"
 email: crow02531@outlook.com
 executables: []
 extensions: []
@@ -55,6 +56,7 @@ files:
 - lib/jekyll-t4j/engine/katex.rb
 - lib/jekyll-t4j/merger.rb
 - lib/jekyll-t4j/renderer.rb
+- lib/jekyll-t4j/snippet.rb
 - lib/jekyll-t4j/version.rb
 homepage: https://github.com/crow02531/jekyll-t4j
 licenses:
@@ -76,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - A TeX distribution
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: LaTeX support for Jekyll.