jekyll-spaceship 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5aea23b39241812e97de9e3f6dc6f47db7a4fa743d6510de8cbc6fc8e1c90fb
-  data.tar.gz: 324717f9b72366dd9f2d7e51c378937222c5884380c903897781b4875d33e067
+  metadata.gz: 26f4057b47af49da27acf7f6d6b26851e9094b70f4c2a939270d8fbb0c49272f
+  data.tar.gz: 64a5c8f08a467de5a67a24d89dba5785d48e2d68add11a8acb10e4199e01922c
 SHA512:
-  metadata.gz: d0bcaeb2c487b51961678cd2ea6e665466d75dc2c6c8b51b2e723121a7c2f0889a536836f11c48dc33b8784f871976fb43607824dfede322fb3e3f859007226d
-  data.tar.gz: a222d1377e23672f35815a8f8d870f247688663897d728e2b5d108b57573dc0a0f24735608a189c31ea20957d26c0cd3af3f1f8e30bbc3d80ebf70d47cb09531
+  metadata.gz: decab1852e2c7f1dc439eee47805ca18d1192657b7ebb2c707737a031734e376f971d1b5e22e3ea435308caf010ad5f90d55fa13353170822cee5c51c0496b3b
+  data.tar.gz: 9d11c7b8437a5047b52370ca49de6f84360a80dcb0021f687b0b817644095ab2086b0157a6b2587bc9041906b698005556d444d8f05719b106bc65ec9b361912

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)
@@ -148,10 +149,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 +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/
 ```
 
@@ -546,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
 ```
 ````
@@ -569,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?**"
 
@@ -603,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)
 ```
 
@@ -613,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)
 ```
 
@@ -623,9 +690,7 @@ the link as below:
 
 ```markdown
 ![](https://vimeo.com/263856289)
-```
 
-```markdown
 ![](https://vimeo.com/263856289?width=500&height=320)
 ```
 
@@ -633,9 +698,7 @@ the link as below:
 
 ```markdown
 ![](https://www.dailymotion.com/video/x7tfyq3)
-```
 
-```markdown
 ![](https://dai.ly/x7tgcev?width=100%&height=400)
 ```
 
@@ -643,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.
 
@@ -688,7 +747,7 @@ Bob -> Alice : hello
 </script>
 ```
 
-### 6. Markdown Polyfill
+### 7. Markdown Polyfill
 
 It allows us to polyfill features for extending markdown syntax.
 
@@ -696,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.
 
@@ -730,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).
@@ -745,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:
 
@@ -757,7 +816,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, 
@@ -853,6 +912,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/cores/config.rb

@@ -8,6 +8,7 @@ module Jekyll::Spaceship
         'table-processor',
         'mathjax-processor',
         'plantuml-processor',
+        'mermaid-processor',
         'polyfill-processor',
         'video-processor',
         'emoji-processor',

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.7.3"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spaceship
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - jeffreytse
@@ -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: []