jekyll-spaceship 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2a6f219ec49d2767f11891946203051ed55b82567d0021c929eb1831769e246
-  data.tar.gz: 80bdf4869aaf201752f791031b6730b0d3e86681cdb246f4855db960ec913a60
+  metadata.gz: c6ae47db0fb8b3515463a5703cdbfa2c596262066b0af602e3d7f82360872c78
+  data.tar.gz: 9f4c96c07fe26d5b1e9a44338375a29470d528e2375902d9e7198cfe377d0b26
 SHA512:
-  metadata.gz: b7ff25fd47603c5f3471db4d33cad716956ee41918fa5408fae35176025658122ee4cc567db6a68675d4c1e677d9f7b50a0e32ce12fb0eae1a3e8525503be8f0
-  data.tar.gz: ca6a2e4071c8eac5f8759778bb2c0e228a3b94369c16815fb150e8041b685a11e60f18dcd7f05afae3e9fbcf8075b5bfb61046248ff440b5dbefb80cedcef02e
+  metadata.gz: 7a24363b63096f27c60c92aa0ad37561cf230ae6e61c0e49b7c556e9a584c1ffddc388cf3ab3cb424382351d55a30439628f6a909e93aae4cfce51363f8ffd0f
+  data.tar.gz: 297d038c14a9bdb8b856b414eaefba93232ff82518a3c01eaf97ac98f2dd1792d6d875a140e5f30497dbcb759f4e59a6ea6632c64c186f0acacfb249152b2c3e

data/README.md

@@ -101,6 +101,7 @@ Spaceship is a minimalistic, powerful and extremely customizable [Jekyll](https:
     - [1.3 Headerless](#headerless)
     - [1.4 Cell Alignment](#cell-alignment)
     - [1.5 Cell Markdown](#cell-markdown)
+    - [1.6 Cell Inline Attributes](#cell-inline-attributes)
   - [2. MathJax Usage](#2-mathjax-usage)
     - [2.1 Performance Optimization](#21-performance-optimization)
     - [2.2 How to use?](#22-how-to-use)
@@ -165,12 +166,16 @@ jekyll-spaceship:
     - emoji-processor
     - element-processor
   mathjax-processor:
-    src:  //cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
+    src:
+      - https://polyfill.io/v3/polyfill.min.js?features=es6
+      - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
     config:
-      tex2jax:
+      tex:
         inlineMath:
           - ['$','$']
           - ['\(','\)']
+      svg:
+        fontCache: 'global'
   plantuml-processor:
     mode: default  # mode value 'pre-fetch' for fetching image at building stage
     css:
@@ -534,6 +539,61 @@ Rowspan is 4
 </tbody>
 </table>
 
+#### Cell Inline Attributes
+
+This feature is very useful for custom cell such as using inline style. (e.g., background, color, font)  
+The idea and syntax comes from the [Maruku](http://maruku.rubyforge.org/) package.  
+
+[](https://kramdown.gettalong.org/syntax.html#block-ials)
+
+Following are some examples of attributes definitions (ALDs) and afterwards comes the syntax explanation:
+
+```markdown
+{:ref-name: #id .cls1 .cls2}
+{:second: ref-name #id-of-other title="hallo you"}
+{:other: ref-name second}
+```
+
+An ALD line has the following structure:
+
+- a left brace, optionally preceded by up to three spaces,
+- followed by a colon, the id and another colon,
+- followed by attribute definitions (allowed characters are backslash-escaped closing braces or any character except a not escaped closing brace),
+- followed by a closing brace and optional spaces until the end of the line.
+
+If there is more than one ALD with the same reference name, the attribute definitions of all the ALDs are processed like they are defined in one ALD.
+
+An inline attribute list (IAL) is used to attach attributes to another element.  
+Here are some examples for span IALs:
+
+```markdown
+{: #id .cls1 .cls2} <!-- #id <=> id="id", .cls1 .cls2 <=> class="cls1 cls2" -->
+{: ref-name title="hallo you"}
+{: ref-name class='.cls3' .cls4}
+```
+
+Here is an example for custom table cell with IAL:
+
+```markdown
+{:color-style: style="background: black;"}
+{:color-style: style="color: white;"}
+{:text-style: style="font-weight: 800; text-decoration: underline;"}
+
+|:             Here's an Inline Attribute Lists example                :||||
+| ------- | ------------------ | -------------------- | ------------------ |
+|:       :|:  <div style="color: red;"> &lt; Normal HTML Block > </div> :|||
+| ^^      |   Red    {: .cls style="background: orange" }                |||
+| ^^ IALs |   Green  {: #id style="background: green; color: white" }    |||
+| ^^      |   Blue   {: style="background: blue; color: white" }         |||
+| ^^      |   Black  {: color-style text-style }                         |||
+```
+
+Code above would be parsed as:
+
+<img width="580px" src="https://user-images.githubusercontent.com/9413601/88461592-738afb00-ced7-11ea-9aac-3179023742b0.png" alt="IALs">
+
+Additionally, [here](https://kramdown.gettalong.org/syntax.html#block-ials) you can learn more details about IALs.
+
 ### 2. MathJax Usage
 
 [MathJax](http://www.mathjax.org/) is an open-source JavaScript display engine for LaTeX, MathML, and AsciiMath notation that works in all modern browsers.

data/lib/jekyll-spaceship/cores/manager.rb

@@ -69,7 +69,7 @@ module Jekyll::Spaceship
     end
 
     def self.ext(page)
-      ext = page.path.match(/\.\S+$/)
+      ext = page.path.match(/\.[^.]+$/)
       ext.to_s.rstrip
     end
 

data/lib/jekyll-spaceship/cores/processor.rb

@@ -65,7 +65,7 @@ module Jekyll::Spaceship
 
     def initialize_exclusions
       if @@_exclusions.size.zero?
-        self.class.exclude :code, :math
+        self.class.exclude :code, :math, :liquid_filter
       end
       @exclusions = @@_exclusions.uniq
       @@_exclusions.clear
@@ -121,7 +121,7 @@ module Jekyll::Spaceship
       else
         if Type.html? output_ext
           method = 'on_handle_html'
-        elsif css? output_ext
+        elsif Type.css? output_ext
           method = 'on_handle_css'
         end
         if self.respond_to? method
@@ -156,15 +156,17 @@ module Jekyll::Spaceship
       @exclusions.each do |type|
         regex = nil
         if type == :code
-          regex = /((`+)\s*(\w*)((?:.|\n)*?)\2)/
+          regex = /(((?<!\\)`+)\s*(\w*)((?:.|\n)*?)\2)/
         elsif type == :math
           regex = /(((?<!\\)\${1,2})[^\n]*?\1)/
+        elsif type == :liquid_filter
+          regex = /((?<!\\)((\{\{[^\n]*?\}\})|(\{%[^\n]*?%\})))/
         end
         next if regex.nil?
         content.scan(regex) do |match_data|
           match = match_data[0]
           id = @exclusion_store.size
-          content = content.sub(match, "[JEKYLL@#{object_id}@#{id}]")
+          content = content.sub(match, "<!JEKYLL@#{object_id}@#{id}>")
           @exclusion_store.push match
         end
       end
@@ -175,7 +177,7 @@ module Jekyll::Spaceship
       while @exclusion_store.size > 0
         match = @exclusion_store.pop
         id = @exclusion_store.size
-        content = content.sub("[JEKYLL@#{object_id}@#{id}]", match)
+        content = content.sub("<!JEKYLL@#{object_id}@#{id}>", match)
       end
       @exclusion_store = []
       content

data/lib/jekyll-spaceship/processors/emoji-processor.rb

@@ -24,15 +24,16 @@ module Jekyll::Spaceship
 
         # escape plus sign
         emoji_name = emoji.name.gsub('+', '\\\+')
+        css_class = self.config['css']['class']
 
         content = content.gsub(
           /(?<!\=")\s*:#{emoji_name}:\s*(?!"\s)/,
-          "<img class=\"\""\
+          "<img class=\"#{css_class}\""\
             " title=\":#{emoji.name}:\""\
             " alt=\":#{emoji.name}:\""\
             " raw=\"#{emoji.raw}\""\
             " src=\"#{config['src']}#{emoji.image_filename}\""\
-            " style=\"vertical-align: middle;"\
+            " style=\"vertical-align: middle; display: inline;"\
             " max-width: 1em; visibility: hidden;\""\
             " onload=\"this.style.visibility='visible'\""\
             " onerror=\"this.replaceWith(this.getAttribute('raw'))\">"\

data/lib/jekyll-spaceship/processors/mathjax-processor.rb

@@ -6,9 +6,13 @@ module Jekyll::Spaceship
   class MathjaxProcessor < Processor
     def self.config
       {
-        'src' => '//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML',
+        'src' => [
+          'https://polyfill.io/v3/polyfill.min.js?features=es6',
+          'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js',
+        ],
         'config' => {
-          'tex2jax' => { 'inlineMath' => [['$','$'], ['\\(','\\)']] }
+          'tex' => { 'inlineMath' => [['$','$'], ['\\(','\\)']] },
+          'svg': { 'fontCache': 'global' }
         }
       }
     end
@@ -27,8 +31,15 @@ module Jekyll::Spaceship
 
       self.handled = true
 
-      cfg = "MathJax.Hub.Config(#{config['config'].to_json});"
-      head.add_child("<script src=\"#{config['src']}\">#{cfg}</script>")
+      # add mathjax config
+      cfg = config['config'].to_json
+      head.add_child("<script>MathJax=#{cfg}</script>")
+
+      # add mathjax dependencies
+      config['src'] = [config['src']] if config['src'].is_a? String
+      config['src'].each do |src|
+        head.add_child("<script src=\"#{src}\"></script>")
+      end
 
       doc.to_html
     end

data/lib/jekyll-spaceship/processors/table-processor.rb

@@ -5,6 +5,9 @@ require "nokogiri"
 
 module Jekyll::Spaceship
   class TableProcessor < Processor
+    ATTR_LIST_PATTERN = /((?<!\\)\{:(?:([A-Za-z]\S*):)?(.*?)(?<!\\)\})/
+    ATTR_LIST_REFS = {}
+
     def on_handle_markdown(content)
       # pre-handle reference-style links
       references = {}
@@ -16,7 +19,9 @@ module Jekyll::Spaceship
       if references.size > 0
         content.scan(/[^\n]*(?<!\\)\|[^\n]*/) do |result|
           references.each do |key, val|
-            replace = result.gsub(/\[([^\n]*)\]\s*\[#{key}\]/, "[\1](#{val})")
+            replace = result.gsub(
+              /\[([^\n\]]*?)\]\s*\[#{key}\]/,
+              "[\1](#{val})")
             next if result == replace
             content = content.gsub(result, replace)
           end
@@ -42,6 +47,19 @@ module Jekyll::Spaceship
         next if result == replace
         content = content.gsub(result, replace)
       end
+
+      # pre-handle attribute list (AL)
+      ATTR_LIST_REFS.clear()
+      content.scan(ATTR_LIST_PATTERN) do |result|
+        ref = result[1]
+        list = result[2]
+        next if ref.nil?
+        if ATTR_LIST_REFS.has_key? ref
+          ATTR_LIST_REFS[ref] += list
+        else
+          ATTR_LIST_REFS[ref] = list
+        end
+      end
       content
     end
 
@@ -69,6 +87,7 @@ module Jekyll::Spaceship
             handle_multi_rows(data)
             handle_text_align(data)
             handle_rowspan(data)
+            handle_attr_list(data)
           end
         end
         rows.each do |row|
@@ -161,7 +180,7 @@ module Jekyll::Spaceship
       if scope.table.multi_row_cells != cells and scope.table.multi_row_start
         for i in 0...scope.table.multi_row_cells.count do
           multi_row_cell = scope.table.multi_row_cells[i]
-          multi_row_cell.inner_html += "<br>#{cells[i].inner_html}"
+          multi_row_cell.inner_html += "\n<br>\n#{cells[i].inner_html}"
         end
         row.remove
       end
@@ -186,7 +205,7 @@ module Jekyll::Spaceship
       span_cell = scope.table.span_row_cells[scope.row.col_index]
       if span_cell and cell.content.match(/^\s*\^{2}/)
         cell.content = cell.content.gsub(/^\s*\^{2}/, '')
-        span_cell.inner_html += "<br>#{cell.inner_html}"
+        span_cell.inner_html += "\n<br>\n#{cell.inner_html}"
         rowspan = span_cell.get_attribute('rowspan') || 1
         rowspan = rowspan.to_i + 1
         span_cell.set_attribute('rowspan', "#{rowspan}")
@@ -235,6 +254,52 @@ module Jekyll::Spaceship
       cell.set_attribute('style', style)
     end
 
+    # Examples:
+    # {:ref-name: .cls1 title="hello" }
+    # {: #id ref-name data="world" }
+    # {: #id title="hello" }
+    # {: .cls style="color: #333" }
+    def handle_attr_list(data)
+      cell = data.cell
+      content = cell.inner_html
+      # inline attribute list(IAL) handler
+      ial_handler = ->(list) do
+        list.scan(/(\S+)=("|')(.*?)\2|(\S+)/) do |attr|
+          key = attr[0]
+          val = attr[2]
+          single = attr[3]
+          if !key.nil?
+            val = (cell.get_attribute(key) || '') + val
+            cell.set_attribute(key, val)
+          elsif !single.nil?
+            if single.start_with? '#'
+              key = 'id'
+              val = single[1..-1]
+            elsif single.start_with? '.'
+              key = 'class'
+              val = cell.get_attribute(key) || ''
+              val += (val.size.zero? ? '' : ' ') + single[1..-1]
+            elsif ATTR_LIST_REFS.has_key? single
+              ial_handler.call ATTR_LIST_REFS[single]
+            end
+            unless key.nil?
+              cell.set_attribute(key, val)
+            end
+          end
+        end
+      end
+      # handle attribute list
+      content.scan(ATTR_LIST_PATTERN) do |result|
+        ref = result[1]
+        list = result[2]
+        # handle inline attribute list
+        ial_handler.call list if ref.nil?
+        # remove attr_list
+        content = content.sub(result[0], '')
+      end
+      cell.inner_html = content
+    end
+
     def handle_format(data)
       cell = data.cell
       cvter = self.converter('markdown')
@@ -242,8 +307,14 @@ module Jekyll::Spaceship
       content = cell.inner_html
         .gsub(/(?<!\\)\|/, '\\|')
         .gsub(/^\s+|\s+$/, '')
+        .gsub(/&lt;/, '<')
+        .gsub(/&gt;/, '>')
       content = cvter.convert(content)
-      cell.inner_html = Nokogiri::HTML.fragment(content)
+      content = Nokogiri::HTML.fragment(content)
+      if content.children.first&.name == 'p'
+        content = content.children
+      end
+      cell.inner_html = content.inner_html
     end
   end
 end

data/lib/jekyll-spaceship/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Spaceship
-    VERSION = "0.8.3"
+    VERSION = "0.9.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spaceship
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - jeffreytse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-04 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -169,8 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to provide powerful supports for table, mathjax, plantuml,