jektex 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1247953962bc4063d49c80f23be942dba3f4ccbf52bc4f9612efb18ffe863358
-  data.tar.gz: bad878b76ed57f3c0a720d84bba5625267124287bb7a8b92f079a4ed678ea441
+  metadata.gz: daa553320105731fb20840fc40d211a73f576f6847b8b3de0019d72313ac0c97
+  data.tar.gz: 4479c3dc694c196845460e4ed63263ad5bb900ed9b3a42fe68e4900001dfccda
 SHA512:
-  metadata.gz: 2e859d1186b3aaae9d33cd1bcbfd96822f9d6470304c7ee23404b6ae6741163924caad83346811652e371738e6a6a7b6035e6df21c217ebf5fca3ef933d30d8c
-  data.tar.gz: ad53f03463c684a321c5a4c43def449a64f18d9ceccf1091004cd0bb5ce73c55dab9edbc29793b92856f9077ba8642de450b4310f97a110d7fa5882d45697f1d
+  metadata.gz: 42333a3f6325918d8e1da7c6dd983c3f8404d10b2ae84449076ba768846793ec992af35e6962ebde5c3ae2619dfc2f4c3211370d9c75f6f6883707fbdf355c03
+  data.tar.gz: 24849a110d4ac120fcccab47f357d0c74ae8f7d640dbcd21c7741dc7cf88096aaef6afe088b99a486fe9589e6f67afa13703f09f395ad5c157f6b3ee542c8672

data/README.md

@@ -2,9 +2,9 @@
 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.
 
-## About
+## Features
 - Renders LaTeX formulas during Jekyll rendering
-- Works without any javascript o clients side
+- 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
@@ -13,12 +13,13 @@ Enjoy comfort of latex and markdown without cluttering your site with bloated ja
 - Does not interfere with Jekyll workflow and project structure
 - Marks invalid syntax in document
 - Prints location of invalid expression during rendering
+- Tags places within the rendered documents with syntax errors
 
 ## Usage
 
 ### Notation
 **Inline formula**  
-Put formula between two pairs of `$` inside of paragraph.
+Put formula between two pairs of dolar signs (`$$`) inside of paragraph.
 
 ```latex
 Lorem ipsum dolor sit amet, consectetur $$e^{i\theta}=\cos(\theta)+i\sin(\theta)$$
@@ -26,12 +27,12 @@ adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliq
 ```
 
 **Display formula**  
-Put formula between two pairs of `$` and surround it between two empty lines.
+Put formula between two pairs of dolar sings (`$$`) and surround it by two empty lines.
 ```latex
-Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor 
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
 incididunt ut labore et dolore magna aliqua.
 
-$$ i\hbar\frac{\partial}{\partial t} \Psi(\mathbf{r},t) = \left [ \frac{-\hbar^2}{2\mu}\nabla^2 + V(\mathbf{r},t)\right ] \Psi(\mathbf{r},t) $$
+$$ \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.
@@ -39,9 +40,8 @@ ea commodo consequat.
 
 _Why Jektex does not use conventional single `$` for inline formulas and double `$$` for
 display mode?  
-Unfortunately this is how [kramdown](https://kramdown.gettalong.org/) 
-(Jekyll's markdown parser) works and it would probably do be easier to write custom 
-markdown parser than hacking kramdown to behave differently._
+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._
 
 ### Macros
 You can define global macros in your `_config.yml` file:
@@ -49,35 +49,47 @@ You can define global macros in your `_config.yml` file:
 ```yaml
 # Jektex macros
 jektex-macros:
-   - ["\\Q", "\\mathbb{Q}"]
-   - ["\\C", "\\mathbb{C}"]
+    - ["\\Q", "\\mathbb{Q}"]
+    - ["\\C", "\\mathbb{C}"]
 ```
 
+### Cache control
+
+**Clearing cache**  
+To clear cached expressions you have to delete `.jektex-cache` directory in your 
+project directory.
+
+**Disabling cache**  
+You can disable caching with `disable_disk_cache = false` in `_config.yml`.
+
 ## Installation
+This plugin is available as a [RubyGem](https://rubygems.org/gems/jektex).
 
-### Using bundler
+**Using bundler**  
 Add `jektex` to your `Gemfile` like this:
 
-```yaml
+```ruby
 group :jekyll_plugins do
-	gem "jektex"
+    gem "jektex"
 end
 ```
 
 and run `bundle install`
 
-### Without bundler
-Just run `gem install jektex` and add jektex to your plugin list in your `_config.yml` 
-file:
-```
-plugins:
-	- jektex
+**Without bundler**  
+Just run `gem install jektex`
 
+**After installation**  
+Add jektex to your plugin list in your `_config.yml` file:
+```yaml
+plugins:
+    - jektex
 ```
 
-### Style sheets
-Do not forget to add `katex.min.css` to you html head:
+and do not 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 and loaded as an asset from your server directly.
+It is much better practice to download **css** file and loaded as an asset from your server directly.
+You can find more information on [KaTeX's website](https://katex.org/docs/browser.html).
+

data/lib/jektex/jektex.rb

@@ -14,11 +14,11 @@ $count_newly_generated_expressions = 0
 $cache = nil
 $disable_disk_cache = false
 
-def convert(doc)
-  # convert HTML enetities back to characters
-  post = HTMLEntities.new.decode(doc.to_s)
-  post = post.gsub(/(\\\()((.|\n)*?)(?<!\\)\\\)/) { |m| escape_method($1, $2, doc.path) }
-  post = post.gsub(/(\\\[)((.|\n)*?)(?<!\\)\\\]/) { |m| escape_method($1, $2, doc.path) }
+def convert(page)
+  # convert HTML entities back to characters
+  post = HTMLEntities.new.decode(page.output.to_s)
+  post = post.gsub(/(\\\()((.|\n)*?)(?<!\\)\\\)/) { |m| escape_method($1, $2, page.path) }
+  post = post.gsub(/(\\\[)((.|\n)*?)(?<!\\)\\\]/) { |m| escape_method($1, $2, page.path) }
   return post
 end
 
@@ -47,7 +47,7 @@ def escape_method( type, string, doc_path )
     # create the cache directory, if it doesn't exist
     begin
       # render using ExecJS
-      @result =  KATEX.call("katex.renderToString", string, 
+      @result =  KATEX.call("katex.renderToString", string,
                           {displayMode: @display,  macros: $global_macros})
     rescue SystemExit, Interrupt
       # save cache to disk
@@ -70,14 +70,14 @@ end
 
 def print_stats
   print "             LaTeX: " + 
-        ($count_newly_generated_expressions).to_s + 
-        " expressions rendered (" + $cache.size.to_s + 
+        ($count_newly_generated_expressions).to_s +
+        " expressions rendered (" + $cache.size.to_s +
         " already cached)        \r"
   $stdout.flush
 end
 
-Jekyll::Hooks.register :documents, :post_render do |doc|
-  doc.output = convert(doc)
+Jekyll::Hooks.register :pages, :post_render do |page|
+  page.output = convert(page)
 end
 
 Jekyll::Hooks.register :site, :after_init do |site|
@@ -91,7 +91,7 @@ Jekyll::Hooks.register :site, :after_init do |site|
   if $global_macros.size == 0
     puts "             LaTeX: no macros loaded"
   else
-    puts "             LaTeX: " + $global_macros.size.to_s + " macro" + 
+    puts "             LaTeX: " + $global_macros.size.to_s + " macro" +
           ($global_macros.size == 1 ? "" : "s") + " loaded"
   end
 
@@ -115,7 +115,6 @@ end
 Jekyll::Hooks.register :site, :post_write do
   # print new line to prevent overwriting previous output
   print "\n"
-  puts 
   # check if caching is enabled
   if $disable_disk_cache == false
     # save cache to disk

data/lib/jektex/version.rb

@@ -1,3 +1,3 @@
 module Jektex
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jektex
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jan Černý
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs