jektex 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9405c84a9c1c4d137d5f9fe152943a72613a52fb741ea8dc3074c64368257b77
-  data.tar.gz: fcf023964df85b84be1ebab055fd778f923a63e3857facc083e451370168b366
+  metadata.gz: a428ba8f2f9f71ee79b44ed698d5314bf89e240eb577f82a1e0e976878875f2b
+  data.tar.gz: 3db9e56ab288eec2e3f9457b4693851b0345f1ec7afabeaabaeba6884aa1c792
 SHA512:
-  metadata.gz: 1fda6a4eda19f919edc732da120ccfe2a20c520476465d53d79a98eb80087d94b438a84b863194009213781f5b15d180a5e7b22a6ca1eeb35e4bf3676da709c2
-  data.tar.gz: 7f3bd08cb26988e28c5ff910148404dcc0dee7f83478bbd04786aa5bf73ca5ea50fc93117e536c417549cb98f2192a27b20bdea99e598d3fcc15b49ef9b71208
+  metadata.gz: '058eeb45c2e9c2bea5b8294084732d6c4b54e7344c360338bb62f6c9e5a8b2c55e99507be1de78cde4b81a14781a68ee4f530253e90980398ce4ea7c0da418ec'
+  data.tar.gz: b6de46d7eb8f639bb7c06ebd0f7aea6df75647d4f8c930fc779d580ec21c33bfa01c9fd909b0cc577c8862310df58c3e59680271ebba99fc95e9e403659bd345

data/README.md

@@ -1,6 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/jektex.svg)](https://rubygems.org/gems/jektex)
 
-# Jektex
+# ![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.
 
@@ -16,9 +16,9 @@ Enjoy the comfort of LaTeX and Markdown without cluttering your site with bloate
 - 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.
 
 ### Kramdown notation
@@ -43,7 +43,7 @@ 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._
 
 
@@ -69,6 +69,9 @@ Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliqu
 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 via your `_config.yml` file.
 
@@ -82,7 +85,6 @@ 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"
 ```
@@ -92,7 +94,6 @@ 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/*" ]
 ```
@@ -103,7 +104,7 @@ This example configuration ignores all `.xml` files, `README.md` and all files i
 Another way to ignore specific posts is setting the `jektex` attribute in front matter to `false`:
 ```yaml
 ---
-ttle: "How Jektex works"
+title: "How Jektex works"
 category: "Development"
 jektex: false
 layout: post
@@ -115,7 +116,6 @@ Setting `jektex` tag to `true` or not setting at all will result in Jektex rende
 **Using macros**  
 You can define global macros:
 ```yaml
-# Jektex macros
 jektex:
   macros:
     - ["\\Q", "\\mathbb{Q}"]
@@ -124,12 +124,21 @@ jektex:
 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:
 ```yaml
 jektex:
   cache_dir: ".jektex-cache"
   ignore: ["*.xml"]
+  silent: false
   macros:
     - ["\\Q", "\\mathbb{Q}"]
     - ["\\C", "\\mathbb{C}"]
@@ -140,6 +149,7 @@ Having no configuration is equivalent to this:
 jektex:
   cache_dir: ".jekyll-cache"
   ignore: []
+  silent: false
   macros: []
 ```
 
@@ -174,6 +184,6 @@ It is much better practice to download the [**css** file](https://cdn.jsdelivr.n
 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

@@ -9,6 +9,7 @@ CACHE_FILE = "jektex-cache.marshal"
 KATEX = ExecJS.compile(open(PATH_TO_JS).read)
 FRONT_MATTER_TAG = "jektex"
 INDENT = " " * 13
+HTML_ENTITY_PARSER = HTMLEntities.new
 
 $global_macros = Hash.new
 $updated_global_macros = Array.new
@@ -18,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
 
@@ -54,7 +56,7 @@ 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 = HTMLEntities.new.decode(page.content.to_s)
+  post = page.content.to_s
   # render inline expressions
   post = post.gsub(/(\\\()((.|\n)*?)(?<!\\)\\\)/) { |m| escape_method($1, $2, page.relative_path) }
   # render display mode expressions
@@ -66,7 +68,7 @@ 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
@@ -74,10 +76,10 @@ def render_kramdown_notation(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
 
@@ -85,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
@@ -104,7 +106,7 @@ 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"
+      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,
@@ -116,7 +118,7 @@ def escape_method( type, expression, doc_path )
     $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
@@ -145,7 +147,7 @@ Jekyll::Hooks.register :site, :after_init do |site|
   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)
@@ -164,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
@@ -186,9 +198,9 @@ end
 
 Jekyll::Hooks.register :site, :post_write do
   # print stats once more to prevent them from being overwriten by error log
-  print_stats
+  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
@@ -200,3 +212,4 @@ Jekyll::Hooks.register :site, :post_write do
   end
 end
 
+