jekyll-spaceship 0.7.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 106c9567e6da2b0de0e2bdfee8cc88bfbb1cb5269456cca7b233e7ef7ff48d7a
-  data.tar.gz: 52287264fd7f7875a6f00e4997e49658461f25698958abd90fed7b8139ac48e3
+  metadata.gz: c2a6f219ec49d2767f11891946203051ed55b82567d0021c929eb1831769e246
+  data.tar.gz: 80bdf4869aaf201752f791031b6730b0d3e86681cdb246f4855db960ec913a60
 SHA512:
-  metadata.gz: 8245dfe8f753198e5a1f9839a804734c6ce4ee77c224055b30c0df90be790f586d68721cf3593e001db916fa6679bf775b511549a9c524eb1ef85ceebc7ec71f
-  data.tar.gz: 7e4a12588c99731ac3f490e0673e7987ba8c2ba816974b5ef2cafc622081e7bc338c76010e00ba32204ab7d1ee6054f156edc79da01ba43d3dd9c04c60267cd4
+  metadata.gz: b7ff25fd47603c5f3471db4d33cad716956ee41918fa5408fae35176025658122ee4cc567db6a68675d4c1e677d9f7b50a0e32ce12fb0eae1a3e8525503be8f0
+  data.tar.gz: ca6a2e4071c8eac5f8759778bb2c0e228a3b94369c16815fb150e8041b685a11e60f18dcd7f05afae3e9fbcf8075b5bfb61046248ff440b5dbefb80cedcef02e

data/README.md

@@ -105,17 +105,18 @@ Spaceship is a minimalistic, powerful and extremely customizable [Jekyll](https:
     - [2.1 Performance Optimization](#21-performance-optimization)
     - [2.2 How to use?](#22-how-to-use)
   - [3. PlantUML Usage](#3-plantuml-usage)
-  - [4. Video Usage](#4-video-usage)
-    - [4.1 Youtube Usage](#youtube-usage)
-    - [4.2 Vimeo Usage](#vimeo-usage)
-    - [4.3 DailyMotion Usage](#dailymotion-usage)
-    - [4.4 General Video Usage](#general-video-usage)
-  - [5. Hybrid HTML with Markdown](#5-hybrid-html-with-markdown)
-  - [6. Markdown Polyfill](#6-markdown-polyfill)
-    - [6.1 Escape Ordered List](#escape-ordered-list)
-  - [7. Emoji Usage](#7-emoji-usage)
-    - [7.1 Emoji Customizing](#71-emoji-customizing)
-  - [8. Modifying Element Usage](#8-modifying-element-usage)
+  - [4. Mermaid Usage](#4-mermaid-usage)
+  - [5. Video Usage](#5-video-usage)
+    - [5.1 Youtube Usage](#youtube-usage)
+    - [5.2 Vimeo Usage](#vimeo-usage)
+    - [5.3 DailyMotion Usage](#dailymotion-usage)
+    - [5.4 General Video Usage](#general-video-usage)
+  - [6. Hybrid HTML with Markdown](#6-hybrid-html-with-markdown)
+  - [7. Markdown Polyfill](#7-markdown-polyfill)
+    - [7.1 Escape Ordered List](#71-escape-ordered-list)
+  - [8. Emoji Usage](#8-emoji-usage)
+    - [8.1 Emoji Customizing](#81-emoji-customizing)
+  - [9. Modifying Element Usage](#9-modifying-element-usage)
 - [Credits](#credits)
 - [Contributing](#contributing)
 - [License](#license)
@@ -139,7 +140,12 @@ plugins:
   - jekyll-spaceship
 ```
 
-**💡 Tip:** Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted plugins](https://pages.github.com/versions/). To use the gem in GitHub Pages, you need to build locally or use CI (e.g. [travis](https://travis-ci.org/), [github workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow)) and deploy to your `gh-pages` branch. [Click here for more information.](https://jekyllrb.com/docs/continuous-integration/github-actions/) (e.g. [https://github.com/jeffreytse/jekyll-jeffreytse-blog](https://github.com/jeffreytse/jekyll-jeffreytse-blog))
+**💡 Tip:** Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted plugins](https://pages.github.com/versions/). To use the gem in GitHub Pages, you need to build locally or use CI (e.g. [travis](https://travis-ci.org/), [github workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow)) and deploy to your `gh-pages` branch.
+
+### Additions
+
+* Here is a GitHub Action named [jekyll-deploy-action](https://github.com/jeffreytse/jekyll-deploy-action) for Jekyll site deployment conveniently. 👍
+* Here is a [Jekyll site](https://github.com/jeffreytse/jekyll-jeffreytse-blog) using Travis to build and deploy to GitHub Pages for your references.
 
 ## Configuration
 
@@ -148,10 +154,12 @@ This plugin runs with the following configuration options by default. Alternativ
 ```yml
 # Where things are
 jekyll-spaceship:
+  # default enabled processors
   processors:
     - table-processor
     - mathjax-processor
     - plantuml-processor
+    - mermaid-processor
     - polyfill-processor
     - video-processor
     - emoji-processor
@@ -164,8 +172,35 @@ jekyll-spaceship:
           - ['$','$']
           - ['\(','\)']
   plantuml-processor:
+    mode: default  # mode value 'pre-fetch' for fetching image at building stage
+    css:
+      class: plantuml
+    syntax:
+      code: 'plantuml!'
+      custom: ['@startuml', '@enduml']
     src: http://www.plantuml.com/plantuml/png/
+  mermaid-processor:
+    mode: default  # mode value 'pre-fetch' for fetching image at building stage
+    css:
+      class: mermaid
+    syntax:
+      code: 'mermaid!'
+      custom: ['@startmermaid', '@endmermaid']
+    config:
+      theme: default
+    src: https://mermaid.ink/svg/
+  video-processor:
+    default:
+      id: 'video-{id}'
+      class: 'video'
+      width: '100%'
+      height: 350
+      border: 0
+      style: 'max-width: 600px'
+      allow: 'encrypted-media; picture-in-picture'
   emoji-processor:
+    css:
+      class: emoji
     src: https://github.githubassets.com/images/icons/emoji/
 ```
 
@@ -191,13 +226,13 @@ This feature is contributed by [pmccloghrylaing](https://github.com/pmccloghryla
 ```markdown
 |              Stage | Direct Products | ATP Yields |
 | -----------------: | --------------: | ---------: |
-|         Glycolysis |           2 ATP |            |
-|                 ^^ |          2 NADH |   3--5 ATP |
+|         Glycolysis |          2 ATP              ||
+| ^^                 |          2 NADH |   3--5 ATP |
 | Pyruvaye oxidation |          2 NADH |      5 ATP |
 |  Citric acid cycle |          2 ATP              ||
-|                 ^^ |          6 NADH |     15 ATP |
-|                 ^^ |          2 FADH |      3 ATP |
-|                                   30--32 ATP    |||
+| ^^                 |          6 NADH |     15 ATP |
+| ^^                 |          2 FADH |      3 ATP |
+|                               30--32 ATP        |||
 ```
 
 Code above would be parsed as:
@@ -398,7 +433,7 @@ Table cell can be set alignment separately.
 ```markdown
 | :        Fruits \|\| Food       : |||
 | :--------- | :-------- | :--------  |
-| Apple      | :  Apple :| Apple      \
+| Apple      | : Apple : | Apple      \
 | Banana     |   Banana  | Banana     \
 | Orange     |   Orange  | Orange     |
 | :   Rowspan is 4    : || How's it?  |
@@ -546,13 +581,13 @@ Code above would be parsed as:
 - class diagram,
 - activity diagram,
 - component diagram,
-- state diagram
+- state diagram,
 - object diagram
 
 There are two ways to create a diagram in your Jekyll blog page:
 
-````markdown
-```plantuml
+````
+```plantuml!
 Bob -> Alice : hello world
 ```
 ````
@@ -569,7 +604,48 @@ Code above would be parsed as:
 
 ![PlantUML Diagram](https://user-images.githubusercontent.com/9413601/82813883-9180b300-9ec8-11ea-8778-f450e0056938.png)
 
-### 4. Video Usage
+### 4. Mermaid Usage
+
+[Mermaid](https://mermaid-js.github.io/) is a Javascript based diagramming and charting tool. It generates diagrams flowcharts and more, using markdown-inspired text for ease and speed.
+
+It allows to quickly write:
+
+- flow chart,
+- pie chart,
+- sequence diagram,
+- class diagram,
+- state diagram,
+- entity relationship diagram,
+- user journey,
+- gantt
+
+There are two ways to create a diagram in your Jekyll blog page:
+
+````
+```mermaid!
+pie title Pets adopted by volunteers
+  "Dogs" : 386
+  "Cats" : 85
+  "Rats" : 35
+```
+````
+
+or
+
+```markdown
+@startmermaid
+pie title Pets adopted by volunteers
+  "Dogs" : 386
+  "Cats" : 85
+  "Rats" : 35
+@endmermaid
+```
+
+Code above would be parsed as:
+
+![Mermaid Diagram](https://user-images.githubusercontent.com/9413601/85282355-2e317300-b4be-11ea-9c30-8f9d61540d14.png)
+
+### 5. Video Usage
 
 How often did you find yourself googling "**How to embed a video in markdown?**"
 
@@ -603,9 +679,7 @@ the link as below:
 
 ```markdown
 ![](https://www.youtube.com/watch?v=Ptk_1Dc2iPY?width=800&height=500)
-```
 
-```markdown
 ![](https://www.dailymotion.com/video/x7tfyq3?width=100%&height=400&autoplay=1)
 ```
 
@@ -613,9 +687,7 @@ the link as below:
 
 ```markdown
 ![](https://www.youtube.com/watch?v=Ptk_1Dc2iPY)
-```
 
-```markdown
 ![](//www.youtube.com/watch?v=Ptk_1Dc2iPY?width=800&height=500)
 ```
 
@@ -623,9 +695,7 @@ the link as below:
 
 ```markdown
 ![](https://vimeo.com/263856289)
-```
 
-```markdown
 ![](https://vimeo.com/263856289?width=500&height=320)
 ```
 
@@ -633,9 +703,7 @@ the link as below:
 
 ```markdown
 ![](https://www.dailymotion.com/video/x7tfyq3)
-```
 
-```markdown
 ![](https://dai.ly/x7tgcev?width=100%&height=400)
 ```
 
@@ -643,18 +711,14 @@ the link as below:
 
 ```markdown
 ![](//www.html5rocks.com/en/tutorials/video/basics/devstories.webm)
-```
 
-```markdown
 ![](//techslides.com/demos/sample-videos/small.ogv?allow=autoplay)
-```
 
-```markdown
 ![](//techslides.com/demos/sample-videos/small.mp4?width=400)
 ```
 
 
-### 5. Hybrid HTML with Markdown
+### 6. Hybrid HTML with Markdown
 
 As markdown is not only a lightweight markup language with plain-text-formatting syntax, but also an easy-to-read and easy-to-write plain text format, so writing a hybrid HTML with markdown is an awesome choice.
 
@@ -668,7 +732,7 @@ It's easy to write markdown inside HTML:
 
 | :        Fruits \|\| Food       : |||
 | :--------- | :-------- | :--------  |
-| Apple      | :  Apple :| Apple      \
+| Apple      | : Apple : | Apple      \
 | Banana     |   Banana  | Banana     \
 | Orange     |   Orange  | Orange     |
 | :   Rowspan is 4    : || How's it?  |
@@ -688,7 +752,7 @@ Bob -> Alice : hello
 </script>
 ```
 
-### 6. Markdown Polyfill
+### 7. Markdown Polyfill
 
 It allows us to polyfill features for extending markdown syntax.
 
@@ -696,7 +760,7 @@ It allows us to polyfill features for extending markdown syntax.
 
 - Escape ordered list
 
-#### Escape Ordered List
+#### 7.1 Escape Ordered List
 
 A backslash at begin to escape the ordered list.
 
@@ -730,7 +794,7 @@ Escaped:
 10. List item Cafe.
 ```
 
-### 7. Emoji Usage
+### 8. Emoji Usage
 GitHub-flavored emoji images and names would allow emojifying content such as: it's raining :cat:s and :dog:s!
 
 Noted that emoji images are served from the GitHub.com CDN, with a base URL of [https://github.githubassets.com](https://github.githubassets.com), which results in emoji image URLs like [https://github.githubassets.com/images/icons/emoji/unicode/1f604.png](https://github.githubassets.com/images/icons/emoji/unicode/1f604.png).
@@ -745,7 +809,7 @@ I give this plugin two :+1:!
 
 I give this plugin two :+1:!
 
-#### 7.1 Emoji Customizing
+#### 8.1 Emoji Customizing
 
 If you'd like to serve emoji images locally, or use a custom emoji source, you can specify so in your `_config.yml` file:
 
@@ -757,7 +821,7 @@ jekyll-spaceship:
 
 See the [Gemoji](https://github.com/github/gemoji) documentation for generating image files.
 
-### 8. Modifying Element Usage
+### 9. Modifying Element Usage
 
 It allows us to modify elements via `CSS3 selectors`. Through it you can easily
 modify the attributes of an element tag, replace the children nodes and so on, 
@@ -844,6 +908,12 @@ jekyll-spaceship:
             loading: eager                     # Replace `loading` value to `eager`
 ```
 
+There are three options when using this method to lazy load images. Here are the supported values for the loading attribute:
+
+- auto: Default lazy-loading behavior of the browser, which is the same as not including the attribute.
+- lazy: Defer loading of the resource until it reaches a calculated distance from the viewport.
+- eager: Load the resource immediately, regardless of where it’s located on the page.
+
 
 ## Credits
 
@@ -853,6 +923,7 @@ jekyll-spaceship:
 - [jmoji](https://github.com/jekyll/jemoji) - GitHub-flavored emoji plugin for Jekyll.
 - [jekyll-target-blank](https://github.com/keithmifsud/jekyll-target-blank) - Automatically opens external links in a new browser for Jekyll Pages, Posts and Docs.
 - [jekyll-loading-lazy](https://github.com/gildesmarais/jekyll-loading-lazy) - Automatically adds loading="lazy" to img and iframe tags to natively load lazily.
+- [mermaid](https://github.com/mermaid-js/mermaid) - Generation of diagram and flowchart from text in a similar manner as markdown.
 
 ## Contributing
 

data/jekyll-spaceship.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = Jekyll::Spaceship::VERSION
   spec.authors       = ["jeffreytse"]
   spec.email         = ["jeffreytse.mail@gmail.com"]
-  spec.summary       = "A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, emoji, video, youtube, vimeo, dailymotion, etc."
+  spec.summary       = "A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, mermaid, emoji, video, youtube, vimeo, dailymotion, etc."
   spec.homepage      = "https://github.com/jeffreytse/jekyll-spaceship"
   spec.license       = "MIT"
 

data/lib/jekyll-spaceship.rb

@@ -8,5 +8,5 @@ require 'jekyll-spaceship/cores/register'
 
 module Jekyll::Spaceship
   Logger.display_info
-  Config.load
+  Config.load_config
 end

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

@@ -8,6 +8,7 @@ module Jekyll::Spaceship
         'table-processor',
         'mathjax-processor',
         'plantuml-processor',
+        'mermaid-processor',
         'polyfill-processor',
         'video-processor',
         'emoji-processor',
@@ -35,7 +36,7 @@ module Jekyll::Spaceship
       @@store[section] = deep_merge(default, @@store[section])
     end
 
-    def self.load(config = self.site_config)
+    def self.load(config = {})
       config = deep_merge(
         { CONFIG_NAME => DEFAULT_CONFIG },
         config
@@ -50,8 +51,11 @@ module Jekyll::Spaceship
       end
     end
 
-    def self.site_config
-      Jekyll.sites.first.config
+    def self.load_config
+      # post load site config for `group :jekyll_plugin`
+      Jekyll::Hooks.register :site, :after_init do |site|
+        self.load(site.config)
+      end
     end
   end
 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, :block_quotes
+        self.class.exclude :code, :math
       end
       @exclusions = @@_exclusions.uniq
       @@_exclusions.clear
@@ -157,6 +157,8 @@ module Jekyll::Spaceship
         regex = nil
         if type == :code
           regex = /((`+)\s*(\w*)((?:.|\n)*?)\2)/
+        elsif type == :math
+          regex = /(((?<!\\)\${1,2})[^\n]*?\1)/
         end
         next if regex.nil?
         content.scan(regex) do |match_data|

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

@@ -45,61 +45,11 @@ module Jekyll::Spaceship
       if data.kind_of? String
         element.replace Nokogiri::HTML.fragment(data)
       elsif data.kind_of? Hash
-        # set name
-        element.name = data['name'] unless data['name'].nil?
-
-        # set props
-        data['props']&.each do |prop, val|
-          next element.remove_attribute if val.nil?
-          if val.kind_of? Array
-            next if val.size != 2
-            v = element[prop]
-            v = '' if v.nil?
-            val = v.sub(/#{val[0]}/, val[1])
-          elsif val.kind_of? Hash
-            result = []
-            val.each { |k, v| result.push "#{k}: #{v}" }
-            val = result.join(";")
-          end
-          element.set_attribute(prop, val)
-        end
-
-        # processing children
-        return unless data.has_key?('children')
-        return element.inner_html = "" if data['children'].nil?
-        children = self.create_children({
+        handle_hash_element({
           :doc => doc,
-          :data => data['children']
+          :element => element,
+          :data => data,
         })
-
-        # replace whole inner html
-        unless data['children'].kind_of? Array
-          return element.inner_html = children
-        end
-
-        if element.children.size.zero?
-          return element.inner_html = children
-        end
-
-        index = data['children'].index(nil)
-        if index.nil?
-          return element.inner_html = children
-        end
-
-        # insert to the end of children
-        if index == 0
-          return element.children.last.after(children)
-        end
-
-        # insert to the begin of children
-        rindex = data['children'].rindex { |item| !item.nil? }
-        if index == rindex + 1
-          return element.children.first.before children
-        end
-
-        # wrap the children
-        element.children.first.before children[0..index]
-        element.children.last.after children[index..children.size]
       end
     end
 
@@ -126,6 +76,45 @@ module Jekyll::Spaceship
       root.children
     end
 
+    def handle_hash_element(data)
+      doc = data[:doc]
+      element = data[:element]
+      data = data[:data]
+
+      # set name
+      element.name = data['name'] unless data['name'].nil?
+
+      # set props
+      data['props']&.each do |prop, val|
+        next element.remove_attribute if val.nil?
+        if val.kind_of? Array
+          next if val.size != 2
+          v = element[prop]
+          v = '' if v.nil?
+          val = v.sub(/#{val[0]}/, val[1])
+        elsif val.kind_of? Hash
+          result = []
+          val.each { |k, v| result.push "#{k}: #{v}" }
+          val = result.join(";")
+        end
+        element.set_attribute(prop, val)
+      end
+
+      # processing children
+      return unless data.has_key?('children')
+      return element.inner_html = "" if data['children'].nil?
+      children = self.create_children({
+        :doc => doc,
+        :data => data['children']
+      })
+
+      handle_element_placement({
+        :data => data,
+        :element => element,
+        :children => children,
+      })
+    end
+
     def create_element(data)
       doc = data[:doc]
       data = data[:data]
@@ -148,5 +137,34 @@ module Jekyll::Spaceship
       end
       node
     end
+
+    def handle_element_placement(data)
+      element = data[:element]
+      children = data[:children]
+      data = data[:data]
+
+      # replace whole inner html
+      unless data['children'].kind_of? Array
+        return element.inner_html = children
+      end
+
+      if element.children.size.zero?
+        return element.inner_html = children
+      end
+
+      index = data['children'].index(nil)
+      rindex = data['children'].rindex { |item| !item.nil? }
+
+      if index.nil?
+        element.inner_html = children
+      elsif index == 0 # insert to the end of children
+        element.children.last.after(children)
+      elsif index == rindex + 1 # insert to the begin of children
+          element.children.first.before children
+      else # wrap the children
+        element.children.first.before children[0..index]
+        element.children.last.after children[index..children.size]
+      end
+    end
   end
 end

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

@@ -7,7 +7,12 @@ require 'gemoji'
 module Jekyll::Spaceship
   class EmojiProcessor < Processor
     def self.config
-      { 'src' => 'https://github.githubassets.com/images/icons/emoji/' }
+      {
+        'css' => {
+          'class' => 'emoji'
+        },
+        'src' => 'https://github.githubassets.com/images/icons/emoji/'
+      }
     end
 
     def on_handle_html(content)
@@ -22,7 +27,7 @@ module Jekyll::Spaceship
 
         content = content.gsub(
           /(?<!\=")\s*:#{emoji_name}:\s*(?!"\s)/,
-          "<img class=\"emoji\""\
+          "<img class=\"\""\
             " title=\":#{emoji.name}:\""\
             " alt=\":#{emoji.name}:\""\
             " raw=\"#{emoji.raw}\""\

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "base64"
+
+module Jekyll::Spaceship
+  class MermaidProcessor < Processor
+    exclude :none
+
+    def self.config
+      {
+        'mode' => 'default',
+        'syntax' => {
+          'code' => 'mermaid!',
+          'custom' => ['@startmermaid', '@endmermaid']
+        },
+        'css' => {
+          'class' => 'mermaid'
+        },
+        'config': {
+          'theme' => 'default'
+        },
+        'src' => 'https://mermaid.ink/svg/'
+      }
+    end
+
+    def on_handle_markdown(content)
+      # match custom mermaid block and code block
+      syntax = self.config['syntax']
+      code_name = syntax['code']
+      custom = syntax['custom'][-2, 2]
+
+      patterns = [
+        /((`{3,})\s*#{code_name}((?:.|\n)*?)\2)/,
+        /((?<!\\)(#{custom[0]})((?:.|\n)*?)(?<!\\)(#{custom[1]}))/
+      ]
+
+      patterns.each do |pattern|
+        content = handle_mermaid_block(pattern, content)
+      end
+
+      # handle escape custom mermaid block
+      content.gsub(/\\(#{custom[0]}|#{custom[1]})/, '\1')
+    end
+
+    def handle_mermaid_block(pattern, content)
+      content.scan pattern do |match|
+        match = match.select { |m| not m.nil? }
+        block = match[0]
+        code = match[2]
+
+        self.handled = true
+
+        content = content.gsub(
+          block,
+          handle_mermaid(code)
+        )
+      end
+      content
+    end
+
+    def handle_mermaid(code)
+      # encode to UTF-8
+      code = code.encode('UTF-8')
+
+      url = get_url(code)
+
+      # render mode
+      case self.config['mode']
+      when 'pre-fetch'
+        url = self.get_mermaid_img_data(url)
+      end
+
+      # return img tag
+      css_class = self.config['css']['class']
+      "<img class=\"#{css_class}\" src=\"#{url}\">"
+    end
+
+    def get_url(code)
+      src = self.config['src']
+
+      # wrap code
+      code = {
+        'code' => code.gsub(/^\s*|\s*$/, ''),
+        'mermaid' => config['config']
+      }.to_json
+
+      # set default method
+      src += '{code}' if src.match(/\{.*\}/).nil?
+
+      # encode to base64 string
+      if src.include?('{code}')
+        code = Base64.urlsafe_encode64(code, padding: false)
+        return src.gsub('{code}', code)
+      else
+        raise "No supported src ! #{src}"
+      end
+    end
+
+    def get_mermaid_img_data(url)
+      data = ''
+      begin
+        res = Net::HTTP.get_response URI(url)
+        raise res.body unless res.is_a?(Net::HTTPSuccess)
+        data = Base64.encode64(res.body)
+        content_type = res.header['Content-Type']
+        raise 'Unknown content type!' if content_type.nil?
+        data = "data:#{content_type};base64, #{data}"
+      rescue StandardError => msg
+        data = url
+        logger.log msg
+      end
+      data
+    end
+  end
+end

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

@@ -7,23 +7,37 @@ module Jekyll::Spaceship
   class PlantumlProcessor < Processor
     exclude :none
 
-    PLANTUML_PATTERNS = [
-      /(\\?(@startuml)((?:.|\n)*?)@enduml)/,
-      /((`{3,})\s*plantuml((?:.|\n)*?)\2)/
-    ]
-
     def self.config
-      { 'src' => 'http://www.plantuml.com/plantuml/png/' }
+      {
+        'mode' => 'default',
+        'syntax' => {
+          'code' => 'plantuml!',
+          'custom' => ['@startuml', '@enduml']
+        },
+        'css' => {
+          'class' => 'plantuml'
+        },
+        'src' => 'http://www.plantuml.com/plantuml/png/'
+      }
     end
 
     def on_handle_markdown(content)
-      # match default plantuml block and code block
-      PLANTUML_PATTERNS.each do |pattern|
+      # match custom plantuml block and code block
+      syntax = self.config['syntax']
+      code_name = syntax['code']
+      custom = syntax['custom'][-2, 2]
+
+      patterns = [
+        /((`{3,})\s*#{code_name}((?:.|\n)*?)\2)/,
+        /((?<!\\)(#{custom[0]})((?:.|\n)*?)(?<!\\)(#{custom[1]}))/
+      ]
+
+      patterns.each do |pattern|
         content = handle_plantuml_block(pattern, content)
       end
 
-      # handle escape default plantuml block
-      content.gsub(/\\(@startuml|@enduml)/, '\1')
+      # handle escape custom plantuml block
+      content.gsub(/\\(#{custom[0]}|#{custom[1]})/, '\1')
     end
 
     def handle_plantuml_block(pattern, content)
@@ -32,11 +46,6 @@ module Jekyll::Spaceship
         block = match[0]
         code = match[2]
 
-        # skip escape default plantuml block
-        if block.match(/(^\\@startuml|\\@enduml$)/)
-          next
-        end
-
         self.handled = true
 
         content = content.gsub(
@@ -51,21 +60,43 @@ module Jekyll::Spaceship
       # wrap plantuml code
       code = "@startuml#{code}@enduml".encode('UTF-8')
 
-      # encode to hex string
-      code = '~h' + code.unpack("H*").first
-      data = self.get_plantuml_img_data(code)
+      url = get_url(code)
+
+      # render mode
+      case self.config['mode']
+      when 'pre-fetch'
+        url = self.get_plantuml_img_data(url)
+      end
 
       # return img tag
-      "<img class=\"plantuml\" src=\"#{data}\">"
+      css_class = self.config['css']['class']
+      "<img class=\"#{css_class}\" src=\"#{url}\">"
+    end
+
+    def get_url(code)
+      src = self.config['src']
+
+      # set default method
+      src += '{hexcode}' if src.match(/\{.*\}/).nil?
+
+      # encode to hex string
+      if src.include?('{hexcode}')
+        code = '~h' + code.unpack("H*").first
+        return src.gsub('{hexcode}', code)
+      else
+        raise "No supported src ! #{src}"
+      end
     end
 
-    def get_plantuml_img_data(code)
+    def get_plantuml_img_data(url)
       data = ''
-      url = "#{config['src']}#{code}"
       begin
-        data = Net::HTTP.get URI(url)
-        data = Base64.encode64(data)
-        data = "data:image/png;base64, #{data}"
+        res = Net::HTTP.get_response URI(url)
+        raise res.body unless res.is_a?(Net::HTTPSuccess)
+        data = Base64.encode64(res.body)
+        content_type = res.header['Content-Type']
+        raise 'Unknown content type!' if content_type.nil?
+        data = "data:#{content_type};base64, #{data}"
       rescue StandardError => msg
         data = url
         logger.log msg

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

@@ -8,15 +8,15 @@ module Jekyll::Spaceship
     def on_handle_markdown(content)
       # pre-handle reference-style links
       references = {}
-      content.scan(/(\[(.*)\]:\s*(.*))/) do |match_data|
+      content.scan(/\n\s*(\[(.*)\]:\s*(\S+(\s+".*?")?))/) do |match_data|
         ref_name = match_data[1]
         ref_value = match_data[2]
         references[ref_name] = ref_value
       end
       if references.size > 0
-        content.scan(/.*(?<!\\)\|.*/) do |result|
+        content.scan(/[^\n]*(?<!\\)\|[^\n]*/) do |result|
           references.each do |key, val|
-            replace = result.gsub(/\[(.*)\]\s*\[#{key}\]/, "[\1](#{val})")
+            replace = result.gsub(/\[([^\n]*)\]\s*\[#{key}\]/, "[\1](#{val})")
             next if result == replace
             content = content.gsub(result, replace)
           end
@@ -24,18 +24,21 @@ module Jekyll::Spaceship
       end
 
       # pre-handle row-span
-      content = content.gsub(/(?<!\\)(\|.*\\\s*)\|\s*\n/, "\\1\n")
+      content = content.gsub(/(?<!\\)(\|[^\n]*\\\s*)\|\s*\n/, "\\1\n")
 
       # escape | and :
       content = content.gsub(/\|(?=\|)/, '\\|')
-        .gsub(/\\:(?=.*?(?<!\\)\|)/, '\\\\\\\\:')
-        .gsub(/((?<!\\)\|.*?)(\\:)/, '\1\\\\\\\\:')
+        .gsub(/\\:(?=[^\n]*?(?<!\\)\|)/, '\\\\\\\\:')
+        .gsub(/((?<!\\)\|[^\n]*?)(\\:)/, '\1\\\\\\\\:')
 
       # escape * and _ and $ etc.
-      content.scan(/.*(?<!\\)\|.*/) do |result|
+      content.scan(/[^\n]*(?<!\\)\|[^\n]*/) do |result|
+        # skip for math expression within pipeline
+        next unless result
+          .gsub(/((?<!\\)\${1,2})[^\n]*?\1/, '')
+          .match(/(?<!\\)\|/)
         replace = result.gsub(
-          /(?<!(?<!\\)\\)(\*|\$|\[|\(|\"|_)/,
-          '\\\\\\\\\1')
+          /(?<!(?<!\\)\\)(\*|\$|\[|\(|\"|_)/, '\\\\\\\\\1')
         next if result == replace
         content = content.gsub(result, replace)
       end
@@ -50,6 +53,7 @@ module Jekyll::Spaceship
 
       # handle each table
       doc.css('table').each do |table|
+        next if table.ancestors('code, pre').size > 0
         rows = table.css('tr')
         data.table = table
         data.rows = rows

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

@@ -4,6 +4,20 @@ require 'uri'
 
 module Jekyll::Spaceship
   class VideoProcessor < Processor
+    def self.config
+      {
+        'default' => {
+          'id' => 'video-{id}',
+          'class' => 'video',
+          'width' => '100%',
+          'height' => 350,
+          'border' => 0,
+          'style' => 'max-width: 600px',
+          'allow' => 'encrypted-media; picture-in-picture',
+        }
+      }
+    end
+
     def on_handle_markdown(content)
       content = handle_normal_video(content)
       content = handle_youtube(content)
@@ -87,13 +101,17 @@ module Jekyll::Spaceship
           next true if v == id or v == ''
         end
 
-        css_id = qs['id'] || "video-#{id}"
-        css_class = qs['class'] || 'video'
-        width = qs['width'] || data[:width] || "100%"
-        height = qs['height'] || data[:height] || 350
-        frameborder = qs['frameborder'] || 0
-        style = qs['style'] || 'max-width: 600px'
-        allow = qs['allow'] || "encrypted-media; picture-in-picture"
+        default = self.config['default']
+        css_id = qs['id'] || default['id']
+        css_class = qs['class'] || default['class']
+        width = qs['width'] || data[:width] || default['width']
+        height = qs['height'] || data[:height] || default['height']
+        frameborder = qs['frameborder'] || default['border']
+        style = qs['style'] || default['style']
+        allow = qs['allow'] || default['allow']
+
+        css_id = css_id.gsub('{id}', id)
+        css_class = css_class.gsub('{id}', id)
 
         url = URI(iframe_url ? "#{iframe_url}#{id}" : url).tap do |v|
           v.query = URI.encode_www_form(qs) if qs.size > 0

data/lib/jekyll-spaceship/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spaceship
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.3
 platform: ruby
 authors:
 - jeffreytse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-21 00:00:00.000000000 Z
+date: 2020-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -140,6 +140,7 @@ files:
 - lib/jekyll-spaceship/processors/element-processor.rb
 - lib/jekyll-spaceship/processors/emoji-processor.rb
 - lib/jekyll-spaceship/processors/mathjax-processor.rb
+- lib/jekyll-spaceship/processors/mermaid-processor.rb
 - lib/jekyll-spaceship/processors/plantuml-processor.rb
 - lib/jekyll-spaceship/processors/polyfill-processor.rb
 - lib/jekyll-spaceship/processors/table-processor.rb
@@ -173,5 +174,5 @@ rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to provide powerful supports for table, mathjax, plantuml,
-  emoji, video, youtube, vimeo, dailymotion, etc.
+  mermaid, emoji, video, youtube, vimeo, dailymotion, etc.
 test_files: []