jekyll-t4j 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13b22b3158377122a8dee5d55e4d57e64dd379ca6dc1af6940fc1eb64bbed5f7
+  data.tar.gz: 6a5b3a578efa74a2f0783301f7b8fa1c3211a0678bc9ad6cea73913cd12b516b
+SHA512:
+  metadata.gz: c023286c3b5de954fdec9909e4abccfd4bf8f3b81b9208c616f5c17ef515ad500ab19f9de76b88df47e7eec8389e0eae8512b3f30112c1638bc8dfdd598fc45b
+  data.tar.gz: ff9007ddaedc4bd5839a8ae51523ebc0c188a0188f17d7506c51cbb03f1706dc96e6ac9e70de76a77c40050b9b1d86fd6a9a2790bfa4f4ef33cec0593a82be5c

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 crow02531
+
+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.

data/README.md

@@ -0,0 +1,74 @@
+# Jekyll::T4J
+
+jekyll-t4j is a plugin integrating Jekyll with your local TeX distribution. It enables Jekyll to cope with LaTeX code in your site. If you find MathJax or KaTeX can not cover your needs to write complex articles(i.e. LaTeX using chemfig), this plugin may help you a lot.
+
+Feel free to write any LaTeX! 🎉
+
+## Usage
+
+We start by a simple instance, write a post `2023-02-04-hello-latex.md` and fill it with:
+
+```
+---
+layout: default
+title:  Hello LaTeX
+date:   2023-02-04 14:53:32 +0800
+---
+
+This is an inline math $$r=\sqrt{x^2+y^2}$$.
+
+$$\chemfig{*6((--[::-60]HO)-=(-O-[:30])-(-OH)=-=)}$$
+
+And this is vanillyl alcohol.
+```
+
+Then, open your `_config.yml` file and write:
+
+```yaml
+t4j:
+  packages:
+    - chemfig
+```
+
+Finally, build your site, complete!
+
+### Configuire
+
+As shown above, you can configuire jekyll-t4j via `_config.yml`. Here is the template:
+
+```yaml
+t4j:
+  packages:
+    - pkgA
+    - pkgB[xxx] # 'xxx' is the option passed to 'pkgB'
+    - pkgC
+```
+
+## Installation
+
+First of all, you need to have a TeX distribution. Just download and install [MikTeX](https://miktex.org/) or [Tex Live](https://tug.org/texlive/).
+
+Then, install jekyll-t4j just as other Jekyll plugins. Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-t4j'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install jekyll-t4j
+```
+
+Lastly, add it to your `_config.yml` file:
+
+```yaml
+plugins:
+    - jekyll-t4j
+```

data/lib/jekyll-t4j/engines/dvisvgm.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "tmpdir"
+require "jekyll/cache"
+
+module Jekyll::T4J
+    module Engines
+        @@cache_dvisvgm = Jekyll::Cache.new "Jekyll::T4J::Dvisvgm"
+
+        def self.dvisvgm_raw(src)
+            # setup: write 'src' to 'content.tex'
+            check_tex
+            pwd = Dir.mktmpdir
+            File.write "#{pwd}/content.tex", src
+
+            # call 'latex' to compile: tex->dvi
+            system "latex -halt-on-error content", :chdir => pwd, [:out, :err] => File::NULL, exception: true
+            system "latex -halt-on-error content", :chdir => pwd, [:out, :err] => File::NULL, exception: true
+            # call 'dvisvgm' to convert dvi to svg
+            system "dvisvgm -n -e content", :chdir => pwd, [:out, :err] => File::NULL, exception: true
+
+            # fetch result
+            File.read "#{pwd}/content.svg"
+        ensure
+            FileUtils.remove_entry pwd if pwd
+        end
+
+        def self.dvisvgm(src)
+            @@cache_dvisvgm.getset(src) {dvisvgm_raw(src)}
+        end
+    end
+end

data/lib/jekyll-t4j/engines.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Jekyll::T4J
+    module Engines
+        @@_passed = nil
+
+        def self.has_tex?
+            if @@_passed == nil then
+                @@_passed = system("latex -version", [:out, :err]=>File::NULL) ? true : false
+            end
+
+            @@_passed
+        end
+
+        def self.check_tex
+            unless has_tex?
+                STDERR.puts "You are missing a TeX distribution. Please install:"
+                STDERR.puts "  MiKTeX or TeX Live"
+                raise Errors::FatalException.new("Missing TeX distribution")
+            end
+        end
+    end
+end
+
+require "jekyll-t4j/engines/dvisvgm"

data/lib/jekyll-t4j/merger.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Jekyll::T4J
+    module Merger
+        @@available = true
+        @@cache = {}
+        @@rnd_range = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ$@".chars
+    
+        def self.ask_for_merge(url, filedata, extname)
+            raise "Merge request during post processing!" unless @@available
+
+            request = @@cache[url]
+            request = @@cache[url] = {} unless request
+
+            entry = request.rassoc(filedata.freeze)
+            return entry[0] if entry and entry[0].split(".")[1] == extname
+
+            filename = @@rnd_range.sample(22).join.prepend("_") << "." << extname
+            request[filename] = filedata
+            filename.freeze
+        end
+
+        # write external files
+        Jekyll::Hooks.register :documents, :post_write do |doc|
+            @@available = false
+
+            url = doc.url
+            request = @@cache[url]
+
+            if request then
+                url = File.dirname url unless url.end_with? "/"
+
+                request.each {|k, v|
+                    File.write File.join(doc.site.dest, url, k), v
+                }
+
+                request.clear
+            end
+        end
+
+        # clean up
+        Jekyll::Hooks.register :site, :post_write do
+            @@cache.clear
+            @@available = true
+        end
+    end
+end

data/lib/jekyll-t4j/renderer.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "strscan"
+require "cgi"
+
+module Jekyll::T4J
+    HTML_TEXT_MASK = Regexp.union(
+        %r{\s*<head[\s\S]*?</head>\s*},
+        %r{\s*<script[\s\S]*?</script>\s*},
+        %r{\s*<style[\s\S]*?</style>\s*},
+        %r{\s*<svg[\s\S]*?</svg>\s*},
+        /\s*<!--.*?-->\s*/,
+        /\s*<.*?>\s*/
+    ).freeze
+
+    TEXT_TEX_MASK = Regexp.union(
+        /\\\([\s\S]*?\\\)/,
+        /\\\[[\s\S]*?\\\]/
+    ).freeze
+
+    def self.mask(str, reg)
+        s = StringScanner.new str
+        parts = []
+
+        while not s.eos? do
+            p0 = s.charpos
+            m = s.scan_until(reg)
+
+            if m then
+                p1 = s.charpos - s.matched.size - 1
+
+                parts << [str[p0..p1], true] unless p1 <= p0
+                parts << [s.matched, false]
+            else
+                parts << [str[p0..-1], true]
+                break
+            end
+        end
+
+        parts
+    end
+end
+
+Jekyll::Hooks.register :documents, :post_render do |doc|
+    result = String.new
+
+    gen = -> (s) {
+        is_inline = s.start_with?("\\(")
+
+        s.prepend "\\documentclass{article}#{Jekyll::T4J.cfg_pkgs}\\begin{document}\\pagenumbering{gobble}"
+        s << "\\end{document}"
+        s = Jekyll::T4J::Engines.dvisvgm(s)
+
+        "<img src=\"#{Jekyll::T4J::Merger.ask_for_merge(doc.url, s, "svg")}\" style=\"#{
+            is_inline ? "display:inline;height:1.1em;" : "display:block;margin:0 auto;height:calc(0.1em * #{s[/height='(\S+?)pt'/, 1]});"
+        }\">"
+    }
+
+    for p0 in Jekyll::T4J.mask(doc.output, Jekyll::T4J::HTML_TEXT_MASK)
+        if p0[1] then
+            for p1 in Jekyll::T4J.mask(p0[0], Jekyll::T4J::TEXT_TEX_MASK)
+                p1[0] = gen.(CGI::unescapeHTML p1[0]) if not p1[1]
+
+                result << p1[0]
+            end
+        else
+            result << p0[0]
+        end
+    end
+
+    doc.output = result
+end

data/lib/jekyll-t4j/version.rb

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

data/lib/jekyll-t4j.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+require "jekyll-t4j/version"
+
+module Jekyll::T4J
+    @@cfg_pkgs
+
+    def self.cfg_pkgs
+        @@cfg_pkgs
+    end
+
+    # initialize plugin
+    Jekyll::Hooks.register :site, :after_init do |site|
+        cfg = site.config["t4j"]
+        @@cfg_pkgs = (cfg and (cfg = cfg["packages"])) ? parse_cfg_pkgs(cfg) : ""
+    end
+
+    def self.parse_cfg_pkgs(cfg)
+        ret = String.new
+
+        for p in cfg
+            raise "Illegal config: #{p}" unless p.match(/\s*([\w-]+)(\[[^\[\]]*\])?\s*/)
+            ret << "\\usepackage#{$2}{#{$1}}"
+        end
+
+        ret
+    end
+end
+
+require "jekyll-t4j/merger"
+require "jekyll-t4j/engines"
+require "jekyll-t4j/renderer"

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-t4j
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- crow02531
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description:
+email: crow02531@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-t4j.rb
+- lib/jekyll-t4j/engines.rb
+- lib/jekyll-t4j/engines/dvisvgm.rb
+- lib/jekyll-t4j/merger.rb
+- lib/jekyll-t4j/renderer.rb
+- lib/jekyll-t4j/version.rb
+homepage: https://github.com/crow02531/jekyll-t4j
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- TeX distribution
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: LaTeX support for Jekyll.
+test_files: []