jekyll-spaceship 0.6.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8df3e5c04610d7f6ae766303a8b884e1b3bd0047f72ac489275dd26d133d392a
-  data.tar.gz: '0728453eaace46c6d88aa0395f1d17ae88c17a727aa3be9b10236c222fc3d85e'
+  metadata.gz: 26f4057b47af49da27acf7f6d6b26851e9094b70f4c2a939270d8fbb0c49272f
+  data.tar.gz: 64a5c8f08a467de5a67a24d89dba5785d48e2d68add11a8acb10e4199e01922c
 SHA512:
-  metadata.gz: 1b5e65d14b80d87ebb06b9e3c5cc7c71f6d654940d58034ab314d232d5ff6614bd3b22649259d3658690b5e94b5c4e6983214a0b3e4bdd91cd03e7702901a51e
-  data.tar.gz: f7a171a023c65ceb729ade833fe7193b05000aa24483c1bd0bc6201c28df47f69d503aa2612a866aba1627fc86626f63d38b7db41b8d75a616805b14f1d71fff
+  metadata.gz: decab1852e2c7f1dc439eee47805ca18d1192657b7ebb2c707737a031734e376f971d1b5e22e3ea435308caf010ad5f90d55fa13353170822cee5c51c0496b3b
+  data.tar.gz: 9d11c7b8437a5047b52370ca49de6f84360a80dcb0021f687b0b817644095ab2086b0157a6b2587bc9041906b698005556d444d8f05719b106bc65ec9b361912

data/README.md

@@ -105,16 +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)
+  - [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)
@@ -147,13 +149,16 @@ 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
+    - element-processor
   mathjax-processor:
     src:  //cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
     config:
@@ -162,8 +167,35 @@ jekyll-spaceship:
           - ['$','$']
           - ['\(','\)']
   plantuml-processor:
+    mode: default  # mode value 'pre-fetch' for fetch 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 fetch 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/
 ```
 
@@ -544,13 +576,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
 ```
 ````
@@ -567,7 +599,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?**"
 
@@ -601,9 +674,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)
 ```
 
@@ -611,9 +682,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)
 ```
 
@@ -621,9 +690,7 @@ the link as below:
 
 ```markdown
 ![](https://vimeo.com/263856289)
-```
 
-```markdown
 ![](https://vimeo.com/263856289?width=500&height=320)
 ```
 
@@ -631,9 +698,7 @@ the link as below:
 
 ```markdown
 ![](https://www.dailymotion.com/video/x7tfyq3)
-```
 
-```markdown
 ![](https://dai.ly/x7tgcev?width=100%&height=400)
 ```
 
@@ -641,18 +706,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.
 
@@ -686,7 +747,7 @@ Bob -> Alice : hello
 </script>
 ```
 
-### 6. Markdown Polyfill
+### 7. Markdown Polyfill
 
 It allows us to polyfill features for extending markdown syntax.
 
@@ -694,7 +755,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.
 
@@ -728,7 +789,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).
@@ -743,7 +804,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:
 
@@ -755,6 +816,93 @@ jekyll-spaceship:
 
 See the [Gemoji](https://github.com/github/gemoji) documentation for generating image files.
 
+### 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, 
+it's very flexible, but here is example usage for modifying a document:
+
+```yml
+# Here is a comprehensive example
+jekyll-spaceship:
+  element-processor:
+    css:
+      - a: '<h1>Test</h1>'                     # Replace all `a` tags (String Style)
+      - ['a.link1', 'a.link2']:                # Replace all `a.link1`, `a.link2` tags (Hash Style)
+          name: img                            # Replace element tag name
+          props:                               # Replace element properties
+            title: Good image                  # Add a title attribute
+            src: ['(^.*$)', '\0?a=123']        # Add query string to src attribute by regex pattern
+            style:                             # Add style attribute (Hash Style)
+              color: red
+              font-size: '1.2em'
+          children:                            # Add children to the element
+            -                                  # First empty for adding after the last child node
+            - "<span>Google</span>"            # First child node (String Style)
+            -                                  # Middle empty for wrapping the children nodes
+            - name: span                       # Second child node (Hash Style)
+              props:
+                prop1: "1"                     # Custom property1
+                prop2: "2"                     # Custom property2
+                prop3: "3"                     # Custom property3
+              children:                        # Add nested chidren nodes
+                - "<span>Jekyll</span>"        # First child node (String Style)
+                - name: span                   # Second child node (Hash Style)
+                  props:                       # Add attributes to child node (Hash Style)
+                    prop1: "a"
+                    prop2: "b"
+                    prop3: "c"
+                  children: "<b>Yap!</b>"      # Add children nodes (String Style)
+            -                                  # Last empty for adding before the first child node
+      - a.link: '<a href="//t.com">Link</a>'   # Replace all `a.link` tags (String Style)
+      - 'h1#title':                            # Replace `h1#title` tags (Hash Style)
+          children: I'm a title!               # Replace inner html to new text
+```
+
+#### Example 1
+
+Automatically adds a `target="_blank" rel="noopener noreferrer"` attribute to all external links in Jekyll's content.
+
+```yml
+jekyll-spaceship:
+  element-processor:
+    css:
+      - a:                                     # Replce all `a` tags
+          props:
+            class: ['(^.*$)', '\0 ext-link']   # Add `ext-link` to class by regex pattern
+            target: _blank                     # Replace `target` value to `_blank`
+            rel: noopener noreferrer           # Replace `rel` value to `noopener noreferrer`
+```
+
+#### Example 2
+
+Automatically adds `loading="lazy"` to `img` and `iframe` tags to natively load lazily.
+[Browser support](https://caniuse.com/#feat=loading-lazy-attr) is growing. If a browser does not support the `loading` attribute, it will load the resource just like it would normally.
+
+```yml
+jekyll-spaceship:
+  element-processor:
+    css:
+      - a:                                     # Replce all `a` tags
+          props:                               #
+            loading: lazy                      # Replace `lading` value to `lazy`
+```
+
+In case you want to prevent loading some images/iframes lazily, add
+`loading="eager"` to their tags. This might be useful to prevent flickering of
+images during navigation (e.g. the site's logo).
+
+See the following examples to prevent lazy loading.
+
+```yml
+jekyll-spaceship:
+  element-processor:
+    css:
+      - a:                                     # Replce all `a` tags
+          props:                               #
+            loading: eager                     # Replace `loading` value to `eager`
+```
+
 
 ## Credits
 
@@ -762,6 +910,9 @@ See the [Gemoji](https://github.com/github/gemoji) documentation for generating
 - [MultiMarkdown](https://fletcher.github.io/MultiMarkdown-6) - Lightweight markup processor to produce HTML, LaTeX, and more.
 - [markdown-it-multimd-table](https://github.com/RedBug312/markdown-it-multimd-table) - Multimarkdown table syntax plugin for markdown-it markdown parser.
 - [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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'yaml'
-
 module Jekyll::Spaceship
   class Config
     CONFIG_NAME = 'jekyll-spaceship'
@@ -10,9 +8,11 @@ module Jekyll::Spaceship
         'table-processor',
         'mathjax-processor',
         'plantuml-processor',
+        'mermaid-processor',
         'polyfill-processor',
         'video-processor',
-        'emoji-processor'
+        'emoji-processor',
+        'element-processor'
       ]
     }
 
@@ -32,15 +32,14 @@ module Jekyll::Spaceship
     end
 
     def self.store(section, default)
-      return if @@store[section].nil?
       return @@store[section] if default.nil?
-      @@store[section] = deep_merge(@@store[section], default)
+      @@store[section] = deep_merge(default, @@store[section])
     end
 
-    def self.load(filename = '_config.yml')
+    def self.load(config = {})
       config = deep_merge(
         { CONFIG_NAME => DEFAULT_CONFIG },
-        YAML.load_file(File.expand_path(filename))
+        config
       )[CONFIG_NAME]
       @@store = config
       self.use_processors(config)
@@ -51,5 +50,12 @@ module Jekyll::Spaceship
         Register.use processor
       end
     end
+
+    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/processors/element-processor.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module Jekyll::Spaceship
+  class ElementProcessor < Processor
+    priority :lowest
+
+    def self.config
+      { 'css' => [] }
+    end
+
+    def on_handle_html(content)
+      return content if config['css'].size.zero?
+
+      # use nokogiri to parse html content
+      doc = Nokogiri::HTML(content)
+
+      # handle each css pattern
+      config['css'].each do |data|
+        data.each do |key, val|
+          key = [key] if key.kind_of? String
+          key.each do |pattern|
+            nodes = doc.css(pattern)
+            nodes.each do |element|
+              handle_css_pattern({
+                :doc => doc,
+                :element => element,
+                :data => val
+              })
+            end
+            self.handled = true
+          end
+        end
+      end
+
+      doc.to_html
+    end
+
+    def handle_css_pattern(data)
+      doc = data[:doc]
+      element = data[:element]
+      data = data[:data]
+
+      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({
+          :doc => doc,
+          :data => data['children']
+        })
+
+        # 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
+
+    def create_children(data)
+      doc = data[:doc]
+      data = data[:data]
+      root = Nokogiri::HTML.fragment("")
+
+      data = [data] unless data.kind_of? Array
+      data.each do |child_data|
+        node = self.create_element({
+          :doc => doc,
+          :data => child_data
+        })
+        next if node.nil?
+        unless child_data['children'].nil?
+          node.children = self.create_children({
+            :doc => doc,
+            :data => child_data['children']
+          })
+        end
+        root.add_child node
+      end
+      root.children
+    end
+
+    def create_element(data)
+      doc = data[:doc]
+      data = data[:data]
+
+      return if data.nil?
+      return Nokogiri::HTML.fragment(data) if data.kind_of? String
+      return if data['name'].nil?
+
+      # create node
+      node = doc.create_element(data['name'])
+
+      # set props
+      data['props']&.each do |prop, val|
+        if val.kind_of? Hash
+          result = []
+          val.each { |k, v| result.push "#{k}: #{v}" }
+          val = result.join(";")
+        end
+        node.set_attribute(prop, val)
+      end
+      node
+    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/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.gsub('{id}', id)
+        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.6.3"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spaceship
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.8.0
 platform: ruby
 authors:
 - jeffreytse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-13 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -137,8 +137,10 @@ files:
 - lib/jekyll-spaceship/cores/processor.rb
 - lib/jekyll-spaceship/cores/register.rb
 - lib/jekyll-spaceship/cores/type.rb
+- 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
@@ -172,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: []