jektex 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6f411d475735a808e6fb495464688d7acca5fb2afa3d4f467612fc7d5308b7a
-  data.tar.gz: e322f027b1c7080553a9cf3e3d4145b49166f6d26e3c5502b3daf8a0ce61a0a5
+  metadata.gz: a428ba8f2f9f71ee79b44ed698d5314bf89e240eb577f82a1e0e976878875f2b
+  data.tar.gz: 3db9e56ab288eec2e3f9457b4693851b0345f1ec7afabeaabaeba6884aa1c792
 SHA512:
-  metadata.gz: 30af1bad450e61c9085975a37b6a2142084854d96201eb67e11cc9c80a21d9d3dbbc5894c82610f2cac7ab52b8272f3f5aae8b74bfa054480edbea9865ebbc48
-  data.tar.gz: 06c8353988adc7940217d6a75ca313cf72a65492db30ab5421567c822199dd6c4b57c86a28485a0b146de826b69c6c1ee80ccb00335277f0b23065881670949d
+  metadata.gz: '058eeb45c2e9c2bea5b8294084732d6c4b54e7344c360338bb62f6c9e5a8b2c55e99507be1de78cde4b81a14781a68ee4f530253e90980398ce4ea7c0da418ec'
+  data.tar.gz: b6de46d7eb8f639bb7c06ebd0f7aea6df75647d4f8c930fc779d580ec21c33bfa01c9fd909b0cc577c8862310df58c3e59680271ebba99fc95e9e403659bd345

data/README.md

@@ -1,26 +1,27 @@
 [![Gem Version](https://badge.fury.io/rb/jektex.svg)](https://rubygems.org/gems/jektex)
 
-# Jektex
-Jekyll plugin for blazing fast server side cached LaTeX rendering with support of macros.
-Enjoy comfort of latex and markdown without cluttering your site with bloated javascript.
+# ![Jektex](https://blackblog.cz/assets/img/projects/jektex.svg)
+A Jekyll plugin for blazing-fast server-side cached LaTeX rendering, with support for macros.
+Enjoy the comfort of LaTeX and Markdown without cluttering your site with bloated JavaScript.
 
 ## Features
 - Renders LaTeX formulas during Jekyll rendering
-- Works without any javascript on clients side
-- Is faster than any other server side Jekyll latex renderer
-- Supports user defined global macros
-- Has I/O efficient caching system
-- Has dynamic and informative log during rendering
-- Is easy to setup
-- Does not interfere with Jekyll workflow and project structure
-- Marks invalid syntax in document
-- Prints location of invalid expression during rendering
-- Highly configurable but still having sensible defaults
+- Works without any client-side JavaScript
+- Is faster than any other server-side Jekyll LaTeX renderer
+- Supports user-defined global macros
+- Has I/O-efficient caching system
+- Dynamically informs about the number of expressions during rendering
+- Is very easy to setup
+- Doesn't interfere with Jekyll workflow and project structure
+- Marks invalid expressions in document, printing its location during rendering
+- Is highly configurable with sensible defaults
 - Makes sure that cache does not contain expression rendered with outdated configuration
+- Supports two major LaTeX notations
 
 ## Usage
+Jektex supports both the built-in Kramdown math notation, and the newer LaTeX-only math notation.
 
-### Notation
+### Kramdown notation
 **Inline formula**  
 Put formula between two pairs of dolar signs (`$$`) inside of paragraph.
 ```latex
@@ -29,7 +30,7 @@ adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliq
 ```
 
 **Display formula**  
-Put formula between two pairs of dolar sings (`$$`) and surround it by two empty lines.
+Put formula between two pairs of dolar sings (`$$`) and surround it with two empty lines.
 ```latex
 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
 incididunt ut labore et dolore magna aliqua.
@@ -42,43 +43,65 @@ ea commodo consequat.
 
 _Why Jektex does not use conventional single `$` for inline formulas and double `$$` for
 display mode?  
-This is how [kramdown](https://kramdown.gettalong.org/)(Jekyll's markdown parser) works 
+This is how [kramdown](https://kramdown.gettalong.org/) (Jekyll's markdown parser) works 
 so I decided to respect this convention. It makes this plugin more consistent and universal._
 
+
+### LaTex math mode notation
+**Inline formula**  
+Put formula between two escaped brackets `\(` `\)`.
+Its position in the text does not matter.
+```latex
+Lorem ipsum dolor sit amet, consectetur \(e^{i\theta}=\cos(\theta)+i\sin(\theta)\)
+adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+```
+
+**Display formula**  
+Put formula between two escaped square brackets `\[` `\]`.
+Its position in the text does not matter.
+```latex
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua.
+
+\[ \left[ \frac{-\hbar^2}{2\mu}\nabla^2 + V(\mathbf{r},t)\right] \Psi(\mathbf{r},t) \]
+
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex
+ea commodo consequat.
+```
+
+### Logo macro
+There is a build in macro for jektex logo. You can use it as `\jektex`.
+
 ### Config
-Jektex si highly configurable from your `_config.yml` file
+Jektex si highly configurable via your `_config.yml` file.
 
 **Disabling cache**  
-You can disable caching with `disable_disk_cache = true` in `_config.yml`. Cache is
-enabled by default. You can find more information on [Jekyll official website](https://jekyllrb.com/docs/configuration/options/).
+You can disable caching with `disable_disk_cache = true` in `_config.yml`.
+Caching is enabled by default.
+You can find more information on [Jekyll's official website](https://jekyllrb.com/docs/configuration/options/).
 
 **Setting cache location**  
-By default jektex cache will be saved in `.jekyll-cache` directory. This results in it's
-deletion when you call `jekyll clean`. To prevent cache deletion or you just want to
-change location of cache for another reason you can achieve that by specifying
-`cache_dir` in `_config.yml`.
+By default, Jektex cache will be saved in `.jekyll-cache` directory.
+This results in its deletion when you call `jekyll clean`.
+To prevent cache deletion or to change the cache location, you can specify `cache_dir` in `_config.yml`:
 ```yaml
-# Jektex cache dir location
 jektex:
   cache_dir: ".jektex-cache"
 ```
 
-**Ignore**  
-By default jektex tries to render LaTeX in all files not excluded by Jekyll. But 
-sometimes you get in situation when you do not want to render some files. For example
-_RSS feed_ with excerpts containing LaTeX. As a solution jektex offers `ignore` option.
-You can use conventional wild cards using `*`. For example:
+**Ignoring files**  
+By default, Jektex tries to render LaTeX in all files rendered by Jekyll.
+This can sometimes be undesirable, for example when rendering an _RSS feed_ with excerpts containing LaTeX.
+Jektex solves this by using the `ignore` option:
 ```yaml
-# Jektex ignore files
 jektex:
   ignore: ["*.xml", "README.md", "_drafts/*" ]
 ```
 
-This example configuration ignores all `.xml` files, `README.md` and all files 
-in `_drafts` directory.
+You can use conventional wild cards using `*`.
+This example configuration ignores all `.xml` files, `README.md` and all files in the `_drafts` directory.
 
-Another option for ignoring specific posts is setting `jektex` tag in front matter of
-post to `false`. For example:
+Another way to ignore specific posts is setting the `jektex` attribute in front matter to `false`:
 ```yaml
 ---
 title: "How Jektex works"
@@ -88,20 +111,26 @@ layout: post
 ---
 ```
 
-Setting `jektex` tag to `true` or not setting at all will result in jektex rendering LaTeX
-expressions in that post.
+Setting `jektex` tag to `true` or not setting at all will result in Jektex rendering LaTeX expressions in that post.
 
-**Macros**  
-You can define global macros like this:
+**Using macros**  
+You can define global macros:
 ```yaml
-# Jektex macros
 jektex:
   macros:
     - ["\\Q", "\\mathbb{Q}"]
     - ["\\C", "\\mathbb{C}"]
 ```
-And yes you have to escape backlash(`\`) with another backlash. This is caused by
-[yaml definition](https://yaml.org/).
+And yes, you have to escape the backlash (`\`) with another backlash.
+This is due to the [yaml specification](https://yaml.org/).
+
+**Silencing Jektex output**  
+Jektex periodically informs the user about rendered/cached equations.
+If this is not desired, you can set the `silent` option (`false` by default).
+```yaml
+jektex:
+  silent: true
+```
 
 **Complete examples**  
 Recommended config:
@@ -109,15 +138,18 @@ Recommended config:
 jektex:
   cache_dir: ".jektex-cache"
   ignore: ["*.xml"]
+  silent: false
   macros:
     - ["\\Q", "\\mathbb{Q}"]
     - ["\\C", "\\mathbb{C}"]
 ```
+
 Having no configuration is equivalent to this:
 ```yaml
 jektex:
   cache_dir: ".jekyll-cache"
   ignore: []
+  silent: false
   macros: []
 ```
 
@@ -125,7 +157,7 @@ jektex:
 This plugin is available as a [RubyGem](https://rubygems.org/gems/jektex).
 
 **Using bundler**  
-Add `jektex` to your `Gemfile` like this:
+Add Jektex to your `Gemfile`:
 ```ruby
 group :jekyll_plugins do
     gem "jektex"
@@ -135,22 +167,23 @@ end
 and run `bundle install`
 
 **Without bundler**  
-Just run `gem install jektex`
+Run `gem install jektex`
 
 **After installation**  
-Add jektex to your plugin list in your `_config.yml` file:
+Add Jektex to your plugin list in your `_config.yml` file
 ```yaml
 plugins:
     - jektex
 ```
 
-and do not forget to add `katex.min.css` to you html head:
+and don't forget to add `katex.min.css` to you HTML head:
 ```html
 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.15.2/dist/katex.min.css" integrity="sha384-MlJdn/WNKDGXveldHDdyRP1R4CTHr3FeuDNfhsLPYrq2t0UBkUdK2jyTnXPEK1NQ" crossorigin="anonymous">
 ```
-It is much better practice to download [**css** file](https://cdn.jsdelivr.net/npm/katex@0.15.2/dist/katex.min.css) and load it as an asset from your server directly.
+It is much better practice to download the [**css** file](https://cdn.jsdelivr.net/npm/katex@0.15.2/dist/katex.min.css) and load it as an asset from your server directly.
 You can find more information on [KaTeX's website](https://katex.org/docs/browser.html).
 
 ## Contributions and bug reports
-Feel free to repost any bugs or even make feature request in [issues on official repository](https://github.com/yagarea/jektex/issues).
+Feel free to report any bugs or even make feature request in [issues on official repository](https://github.com/yagarea/jektex/issues).
 I am opened for pull requests as well.
+

data/lib/jektex/jektex.rb

@@ -7,9 +7,9 @@ PATH_TO_JS = File.join(__dir__, "/katex.min.js")
 DEFAULT_CACHE_DIR = ".jekyll-cache"
 CACHE_FILE = "jektex-cache.marshal"
 KATEX = ExecJS.compile(open(PATH_TO_JS).read)
-PARSE_ERROR_PLACEHOLDER = "<b style='color: red;'>PARSE ERROR</b>"
 FRONT_MATTER_TAG = "jektex"
 INDENT = " " * 13
+HTML_ENTITY_PARSER = HTMLEntities.new
 
 $global_macros = Hash.new
 $updated_global_macros = Array.new
@@ -19,6 +19,7 @@ $count_newly_generated_expressions = 0
 $path_to_cache = File.join(DEFAULT_CACHE_DIR, CACHE_FILE)
 $cache = nil
 $disable_disk_cache = false
+$silent = false
 
 $ignored = Array.new
 
@@ -48,11 +49,26 @@ def print_stats
   $stdout.flush
 end
 
-def render(page)
+#######################################################################################
+# Render
+
+def render_latex_notation(page)
+  # check if document is not set to be ignored
+  return page.content if !page.data || is_ignored?(page)
+  # convert HTML entities back to characters
+  post = page.content.to_s
+  # render inline expressions
+  post = post.gsub(/(\\\()((.|\n)*?)(?<!\\)\\\)/) { |m| escape_method($1, $2, page.relative_path) }
+  # render display mode expressions
+  post = post.gsub(/(\\\[)((.|\n)*?)(?<!\\)\\\]/) { |m| escape_method($1, $2, page.relative_path) }
+  return post
+end
+
+def render_kramdown_notation(page)
   # check if document is not set to be ignored
   return page.output if !page.data || is_ignored?(page)
   # convert HTML entities back to characters
-  post = HTMLEntities.new.decode(page.output.to_s)
+  post = page.output.to_s
   # render inline expressions
   post = post.gsub(/(\\\()((.|\n)*?)(?<!\\)\\\)/) { |m| escape_method($1, $2, page.relative_path) }
   # render display mode expressions
@@ -60,10 +76,10 @@ def render(page)
   return post
 end
 
-def escape_method( type, expression, doc_path )
+def escape_method(type, expression, doc_path)
   # detect if expression is in display mode
   is_in_display_mode = type.downcase =~ /\[/
-
+  expression = HTML_ENTITY_PARSER.decode(expression)
   # generate a hash from the math expression
   expression_hash = Digest::SHA2.hexdigest(expression) + is_in_display_mode.to_s
 
@@ -71,7 +87,7 @@ def escape_method( type, expression, doc_path )
   if($cache.has_key?(expression_hash) && !contains_updated_global_macro?(expression))
     # check if expressin conains updated macro
     $count_newly_generated_expressions += 1
-    print_stats
+    print_stats unless $silent
     return $cache[expression_hash]
 
   # else generate one and store it
@@ -79,8 +95,10 @@ def escape_method( type, expression, doc_path )
     # create the cache directory, if it doesn't exist
     begin
       # render using ExecJS
-      result =  KATEX.call("katex.renderToString", expression,
-                          { displayMode: is_in_display_mode,  macros: $global_macros})
+      result = KATEX.call("katex.renderToString", expression,
+                          { displayMode: is_in_display_mode,
+                            macros: $global_macros
+                          })
     rescue SystemExit, Interrupt
       # save cache to disk
       File.open($path_to_cache, "w"){|to_file| Marshal.dump($cache, to_file)}
@@ -88,32 +106,48 @@ def escape_method( type, expression, doc_path )
       raise
     rescue ExecJS::ProgramError => pe
       # catch parse error
-      puts "\e[31m " + pe.message.gsub("ParseError: ", "") + "\n\t"  + doc_path + "\e[0m"
-      return PARSE_ERROR_PLACEHOLDER
+      puts "\e[31m #{pe.message.gsub("ParseError: ", "")}\n\t#{doc_path}\e[0m" unless $silent
+      # render expression with error highlighting enabled
+      return KATEX.call("katex.renderToString", expression,
+                          { displayMode: is_in_display_mode,
+                            macros: $global_macros,
+                            throwOnError: false
+                          })
     end
     # save to cache
-    $cache[expression_hash] = @result
+    $cache[expression_hash] = result
     # update count of newly generated expressions
     $count_newly_generated_expressions += 1
-    print_stats
+    print_stats unless $silent
     return result
   end
 end
 
 Jekyll::Hooks.register :pages, :post_render do |page|
-  page.output = render(page)
+  page.output = render_kramdown_notation(page)
 end
 
 Jekyll::Hooks.register :documents, :post_render do |doc|
-  doc.output = render(doc)
+  doc.output = render_kramdown_notation(doc)
 end
 
+Jekyll::Hooks.register :pages, :pre_render do |page|
+  page.content = render_latex_notation(page)
+end
+
+Jekyll::Hooks.register :documents, :pre_render do |doc|
+  doc.content = render_latex_notation(doc)
+end
+
+#######################################################################################
+# SETTINGS AND INIT
+
 Jekyll::Hooks.register :site, :after_init do |site|
   # load jektex config from config file and if no config is defined make empty one
   config = site.config["jektex"] || Hash.new
 
   # check if there is defined custom cache location in config
-  $path_to_cache = File.join(config["cache_dir"].to_s, CACHE_FILE) if config.has_key?("cache_dir")
+$path_to_cache = File.join(config["cache_dir"].to_s, CACHE_FILE) if config.has_key?("cache_dir")
 
   # load content of cache file if it exists
   if File.exist?($path_to_cache)
@@ -122,7 +156,7 @@ Jekyll::Hooks.register :site, :after_init do |site|
     $cache = Hash.new
   end
 
-  # check if cache is disable in config
+  # check if cache is disabled in config
   $disable_disk_cache = site.config["disable_disk_cache"] if site.config.has_key?("disable_disk_cache")
 
   # load macros
@@ -132,19 +166,29 @@ Jekyll::Hooks.register :site, :after_init do |site|
     end
   end
 
+  # check is silent mode is activated
+  $silent = config["silent"] if config.has_key?("silent")
   # make list of updated macros
   $updated_global_macros = get_list_of_updated_global_macros($global_macros, $cache["cached_global_macros"])
+
   # print macro information
-  if $global_macros.empty?
-    puts "#{INDENT}LaTeX: no macros loaded"
-  else
-    puts "#{INDENT}LaTeX: #{$global_macros.size} macro" +
-      ($global_macros.size == 1 ? "" : "s") + " loaded" +
-      ($updated_global_macros.empty? ? "" : " (#{$updated_global_macros.size} updated)")
+  unless $silent
+    if $global_macros.empty?
+      puts "#{INDENT}LaTeX: no macros loaded" unless $silent
+    else
+      puts "#{INDENT}LaTeX: #{$global_macros.size} macro" \
+        "#{$global_macros.size == 1 ? "" : "s"} loaded" +
+        ($updated_global_macros.empty? ? "" : " (#{$updated_global_macros.size} updated)") unless $silent
+    end
   end
 
+  # add jektex logo macro
+  $global_macros['\jektex'] =
+    '\text{\raisebox{-0.55ex}{J}\kern{-0.3ex}E\kern{-0.25ex}\raisebox{-0.5ex}{K}\kern{-0.7ex}}\TeX'
+
   # load list of ignored files
   $ignored = config["ignore"] if config.has_key?("ignore")
+  $ignored.append("#{$path_to_cache}/*")
 end
 
 Jekyll::Hooks.register :site, :after_reset do
@@ -153,8 +197,10 @@ Jekyll::Hooks.register :site, :after_reset do
 end
 
 Jekyll::Hooks.register :site, :post_write do
+  # print stats once more to prevent them from being overwriten by error log
+  print_stats unless $silent
   # print new line to prevent overwriting previous output
-  print "\n"
+  print "\n" unless $silent
   # check if caching is enabled
   if !$disable_disk_cache
     # save global macros to cache
@@ -166,3 +212,4 @@ Jekyll::Hooks.register :site, :post_write do
   end
 end
 
+