jekyll-spaceship 0.6.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df761631c9d2636245947978d30acc90b604f9ebd7dbfb047350cff020f80709
-  data.tar.gz: 6eb135842d1d1e2f6eb87817a8bbdf7d2c1126a3c0e935e6275ee8ef5dd36a26
+  metadata.gz: d5aea23b39241812e97de9e3f6dc6f47db7a4fa743d6510de8cbc6fc8e1c90fb
+  data.tar.gz: 324717f9b72366dd9f2d7e51c378937222c5884380c903897781b4875d33e067
 SHA512:
-  metadata.gz: 9675c39c1174d6420d08081d52a802865ef0a3773df936ad01cc29323a7d4287af07176328237de283a087154d86e8a3e92cd19e67a4b9ac1dae38e418a21c47
-  data.tar.gz: b3c0d6b610fed90ca7017b25f5e08c880188f5ea9c68f7645e1027f9e8a8fb32b80b0dbc97e446d00a24346f86fbbeb394fea925a2d018af6d68c9e71368f570
+  metadata.gz: d0bcaeb2c487b51961678cd2ea6e665466d75dc2c6c8b51b2e723121a7c2f0889a536836f11c48dc33b8784f871976fb43607824dfede322fb3e3f859007226d
+  data.tar.gz: a222d1377e23672f35815a8f8d870f247688663897d728e2b5d108b57573dc0a0f24735608a189c31ea20957d26c0cd3af3f1f8e30bbc3d80ebf70d47cb09531

data/README.md

@@ -80,10 +80,10 @@
 <br>
 
 
-A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, emoji, youtube, vimeo, dailymotion, etc.
+Spaceship is a minimalistic, powerful and extremely customizable [Jekyll](https://jekyllrb.com/) plugin. It combines everything you may need for convenient work, without unnecessary complications, like a real spaceship.
 
 <p align="center">
-    <img alt="Jekyll Spaceship Demo" src="https://user-images.githubusercontent.com/9413601/82250463-15451780-997e-11ea-8809-f411586d9508.gif" alt="Donate (Ko-fi)" />
+    <img alt="Jekyll Spaceship Demo" src="https://user-images.githubusercontent.com/9413601/82250463-15451780-997e-11ea-8809-f411586d9508.gif" />
 </p>
 
 **💡 Tip:** I hope you enjoy using this plugin. If you like this project, **a little star** for it is your way make a clear statement: **My work is valued**. I would appreciate your support! _Thank you!_
@@ -109,10 +109,13 @@ A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, emoji
     - [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)
 - [Credits](#credits)
 - [Contributing](#contributing)
 - [License](#license)
@@ -152,6 +155,7 @@ jekyll-spaceship:
     - polyfill-processor
     - video-processor
     - emoji-processor
+    - element-processor
   mathjax-processor:
     src:  //cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
     config:
@@ -576,6 +580,7 @@ While its not possible to embed a video in markdown, the best and easiest way is
 - Youtube
 - Vimeo
 - DailyMotion
+- General Video ( mp4 | avi | webm | ogg | ogv | 3gp | flv | mov ... )
 
 There are two ways to embed a video in your Jekyll blog page:
 
@@ -634,6 +639,21 @@ the link as below:
 ![](https://dai.ly/x7tgcev?width=100%&height=400)
 ```
 
+#### General Video Usage
+
+```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
 
 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.
@@ -725,12 +745,114 @@ I give this plugin two :+1:!
 
 I give this plugin two :+1:!
 
+#### 7.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:
+
+```yml
+jekyll-spaceship:
+  emoji-processor:
+    src: "/assets/images/emoji"
+```
+
+See the [Gemoji](https://github.com/github/gemoji) documentation for generating image files.
+
+### 8. 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
 
 - [Jekyll](https://github.com/jekyll/jekyll) - A blog-aware static site generator in Ruby.
 - [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.
 
 ## Contributing
 

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'
@@ -12,7 +10,8 @@ module Jekyll::Spaceship
         'plantuml-processor',
         'polyfill-processor',
         'video-processor',
-        'emoji-processor'
+        'emoji-processor',
+        'element-processor'
       ]
     }
 
@@ -32,15 +31,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 +49,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/cores/processor.rb

@@ -156,13 +156,13 @@ module Jekyll::Spaceship
       @exclusions.each do |type|
         regex = nil
         if type == :code
-          regex = /(`{3}\s*(\w*)((?:.|\n)*?)`{3})/
+          regex = /((`+)\s*(\w*)((?:.|\n)*?)\2)/
         end
         next if regex.nil?
         content.scan(regex) do |match_data|
           match = match_data[0]
           id = @exclusion_store.size
-          content = content.gsub(match, "[//]: JEKYLL_EXCLUDE_##{id}")
+          content = content.sub(match, "[JEKYLL@#{object_id}@#{id}]")
           @exclusion_store.push match
         end
       end
@@ -173,7 +173,7 @@ module Jekyll::Spaceship
       while @exclusion_store.size > 0
         match = @exclusion_store.pop
         id = @exclusion_store.size
-        content = content.gsub("[//]: JEKYLL_EXCLUDE_##{id}", match)
+        content = content.sub("[JEKYLL@#{object_id}@#{id}]", match)
       end
       @exclusion_store = []
       content

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/plantuml-processor.rb

@@ -7,21 +7,30 @@ 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/' }
     end
 
     def on_handle_markdown(content)
       # match default plantuml block and code block
-      pattern = Regexp.union(
-        /(\\?@startuml((?:.|\n)*?)@enduml)/,
-        /(`{3}\s*plantuml((?:.|\n)*?)`{3})/
-      )
+      PLANTUML_PATTERNS.each do |pattern|
+        content = handle_plantuml_block(pattern, content)
+      end
 
+      # handle escape default plantuml block
+      content.gsub(/\\(@startuml|@enduml)/, '\1')
+    end
+
+    def handle_plantuml_block(pattern, content)
       content.scan pattern do |match|
         match = match.select { |m| not m.nil? }
         block = match[0]
-        code = match[1]
+        code = match[2]
 
         # skip escape default plantuml block
         if block.match(/(^\\@startuml|\\@enduml$)/)
@@ -35,9 +44,7 @@ module Jekyll::Spaceship
           handle_plantuml(code)
         )
       end
-
-      # handle escape default plantuml block
-      content.gsub(/\\(@startuml|@enduml)/, '\1')
+      content
     end
 
     def handle_plantuml(code)

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

@@ -92,7 +92,7 @@ module Jekyll::Spaceship
         width = qs['width'] || data[:width] || "100%"
         height = qs['height'] || data[:height] || 350
         frameborder = qs['frameborder'] || 0
-        style = qs['style'] || ''
+        style = qs['style'] || 'max-width: 600px'
         allow = qs['allow'] || "encrypted-media; picture-in-picture"
 
         url = URI(iframe_url ? "#{iframe_url}#{id}" : url).tap do |v|

data/lib/jekyll-spaceship/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Spaceship
-    VERSION = "0.6.2"
+    VERSION = "0.7.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spaceship
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.3
 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,6 +137,7 @@ 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/plantuml-processor.rb