jekyll-t4j 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 373ef8ace0a1a10dc58cbc1bcb3eb0441cf66894ad27b3a30c87dc2fef6f669d
-  data.tar.gz: a3397303ce58f5b728608e65a2c28ca9eca192d73a6bb9a0dffe243bc8ea2862
+  metadata.gz: 0a1870ef42a1f2b51f55427bf9fc304e59224e0d473c9f1e0c43297ad2347709
+  data.tar.gz: 47330b060c44e1850c8691d2d88e302483c4069bf166b6f9dd4720b92170275b
 SHA512:
-  metadata.gz: 802513ceba69d9729273fa2928b70c7011bf8bd5f9f0756ba89b0d10bb43f8266c27152a3ed1d926f29af41c42e55fbeae6dffdc1bc4c47f33ff10dde08b3a01
-  data.tar.gz: e3fd8c11ed01a7f25e68d323ac86e4d698e2c2de598c89e8b999d3f8889be0ed9c37b3620f64cd28a9eee926fd37f97daede90b906bf42d807118fa57949b3bf
+  metadata.gz: b0842f23b676c35dfdbca726b144c243c0331d56200833af4e47c61210a5b833d0e86cd02cfd022f34b69b0af24272d46630e50521da98125343640115c22c66
+  data.tar.gz: 16d051b87d412c97fa69ed6222aadd4367506733b39963ccd91896f15a7eb8874b761bdd3db3bce4c2a3c1d8cc0e6445c5039eba1c14c2fe67d2e430dc3e2e5a

data/README.md

@@ -1,12 +1,18 @@
 # 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.
+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.
+- **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! 🎉
 
-## Usage
+## Getting Started
 
-We start by a simple instance, write a post `2023-02-04-hello-latex.md` and fill it with:
+Let's start by a simple instance, write a post `2023-02-04-hello-latex.md` and fill it with:
 
 ```
 ---
@@ -15,14 +21,16 @@ title:  Hello LaTeX
 date:   2023-02-04 14:53:32 +0800
 ---
 
-This is an inline math $$r=\sqrt{x^2+y^2}$$.
+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:
+As you can see, its usage is the same as KaTeX or MathJax, but we only allow delimiters `$...$`, `$$...$$`, `\(...\)`, `\[...\]`.
+
+Because we use the chemfig package, so open your `_config.yml` file and write:
 
 ```yaml
 t4j:
@@ -32,23 +40,13 @@ t4j:
 
 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
-```
+You can learn more about T4J [here](https://github.com/crow02531/jekyll-t4j/wiki).
 
 ## 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/).
+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/). Other TeX distirbution is also available.
 
-Then, install jekyll-t4j just as other Jekyll plugins. Add this line to your application's Gemfile:
+Then, install jekyll-t4j like other Jekyll plugins. Add this line to your application's Gemfile:
 
 ```ruby
 gem 'jekyll-t4j'

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "tmpdir"
+
+module Jekyll::T4J
+    module Engine
+        @@_pwd_fmt_ = nil
+
+        def self.setup_dvisvgm
+            if not @@_pwd_fmt_ then
+                @@_pwd_fmt_ = Dir.mktmpdir
+                at_exit {FileUtils.remove_entry @@_pwd_fmt_}
+
+                # write 'preamble.tex'
+                File.write "#{@@_pwd_fmt_}/preamble.tex", <<~HD
+                    \\documentclass{article}
+                    #{Jekyll::T4J.cfg_pkgs}
+                    \\input{#{File.join(__dir__, "dvisvgm.tex")}}
+                    \\pagenumbering{gobble}
+                    \\dump
+                HD
+
+                # call 'latex' to precompile
+                shell("latex -ini -halt-on-error -jobname=\"preamble\" \"&latex preamble\"", @@_pwd_fmt_)
+            end
+        end
+
+        def self.dvisvgm_raw(snippet)
+            dvisvgm_raw_bulk([snippet])[0]
+        end
+
+        def self.dvisvgm_raw_bulk(snippets)
+            # create 'content.tex'
+            pwd = Dir.mktmpdir
+            File.write "#{pwd}/content.tex", <<~HD
+                \\begin{document}
+                \\begingroup#{snippets.join("\\endgroup\\newpage\\begingroup")}\\endgroup
+                \\end{document}
+            HD
+
+            # call 'latex' to compile: tex->dvi
+            shell("latex --fmt=\"#{File.join(@@_pwd_fmt_, "preamble.fmt")}\" -halt-on-error content", pwd, 2)
+            # call 'dvisvgm' to convert dvi to svg(s)
+            shell("dvisvgm -n -e -p 1- -o %1p content", pwd)
+
+            # fetch results
+            results = []
+            for i in 1..snippets.size
+                results << File.read("#{pwd}/#{i.to_s}.svg")
+            end
+
+            # return
+            results
+        ensure
+            FileUtils.remove_entry pwd if pwd
+        end
+    end
+end

data/lib/jekyll-t4j/engine/dvisvgm.tex

@@ -0,0 +1,8 @@
+\usepackage{amsmath}
+\usepackage{amssymb}
+
+\let\OLDLATEX\LaTeX
+\let\OLDTEX\TeX
+\renewcommand{\LaTeX}{\text{\OLDLATEX}}
+\renewcommand{\TeX}{\text{\OLDTEX}}
+% TODO: elimiate the difference between katex and latex.