h2o-ac-jekyll-extlinks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e484818952d26986d7abda90750340177dcea1f67b49c6a5967334c69532938
+  data.tar.gz: e3b9992c0da16660d4f4e40d282662e5cffa6be6ff3cc3fd81fc5dfcc79e295b
+SHA512:
+  metadata.gz: 1a198e66810b990940cdea1febfd44f367ce8e0a975d1e1a44673ea3c8c68b8e09b06f3b7a0faecc2317d1650bc72edbddbc5692f2f4403e378c82193acc5003
+  data.tar.gz: 4d0ec454a9b4c38b2e35112d16a968a5642a99b0e69b134a35ad4d28be11ff44bf08b48108a3b1347f921ca1adc2c7e3e0296c91ad06b86404fecf079fa9326f

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/License

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Dmitry Ogarkov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Jekyll ExtLinks
+
+This Jekyll plugin adds custom attributes (`rel="nofollow"`, `target="_blank"`, etc.) to external links in your content.
+
+This Jekyll plugin adds custom attributes to external links in your content. For example, you can add `rel="nofollow"` to all external links by default (with exceptions if you need them), or something like `class="external"`. You can also use it to add `target="_blank"` to external links, but generally it is not recommended as it leads to bad user experience. Multiple attributes are allowed.
+
+## Installation
+
+1. Install the gem from RubyGems: `gem install h2o-ac-jekyll-extlinks`.
+
+2. Add this to your project's `Gemfile`:
+
+  ```ruby
+  gem 'h2o-ac-jekyll-extlinks'
+  ```
+
+3. Add this to your project's `_config.yml`:
+
+  ```yml
+  plugins:
+    - jekyll-extlinks
+  ```
+
+## Configuration
+
+Configure the plugin in your `_config.yml`. Notice the indentation matters. Example:
+
+```yml
+extlinks:
+  attributes: {rel: nofollow, target: _blank, class: external}
+  rel_exclude: ['host1.com', 'host2.net']
+  class_exclude: ['host1.com', 'host2.net']
+```
+
+* `attributes` are required - at least one of them; `rel_exclude` and `class_exclude` are optional
+* Links to hosts listed in `rel_exclude` will not have the `rel` attribute set
+* Links to hosts listed in `class_exclude` will not have the `class` attribute set
+* Links which have the `rel` attribute already will keep it unchanged, like this one in Markdown: `[Link text](http://someurl.com){:rel="dofollow"}`
+* Relative links will not be processed
+* Don't forget to actually use the plugin (see below)
+
+## Usage
+
+Use the plugin in your Jekyll layouts: `{{ content | extlinks }}`
+
+## Notes
+
+Developed by Dmitry Ogarkov - <http://ogarkov.com/jekyll/plugins/extlinks/>
+
+Based on <http://dev.mensfeld.pl/2014/12/rackrails-middleware-that-will-ensure-relnofollow-for-all-your-links/>
+
+Revised by zhonger - <https://github.com/zhonger/jekyll-extlinks>

data/jekyll-extlinks.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = "h2o-ac-jekyll-extlinks"
+  s.version     = "0.0.1"
+  s.date        = "2022-08-29"
+  s.summary     = "Jekyll ExtLinks Plugin"
+  s.description = <<-EOF
+    Adds custom attributes to external links (rel="nofollow", target="_blank", etc.)
+  EOF
+  s.authors     = ["Dmitry Ogarkov"]
+  s.email       = "dima@ogarkov.com"
+  s.files       = ["lib/jekyll-extlinks.rb", "Gemfile", "jekyll-extlinks.gemspec", "License", "README.md"]
+  s.homepage    = "https://github.com/zhonger/jekyll-extlinks/"
+  s.license     = "MIT"
+
+  s.add_runtime_dependency "jekyll", "~> 4.0"
+  s.add_runtime_dependency "nokogiri", "~> 1"
+end

data/lib/jekyll-extlinks.rb

@@ -0,0 +1,85 @@
+# Jekyll ExtLinks Plugin
+# Adds custom attributes to external links (rel="nofollow", target="_blank", etc.)
+#
+# Configuration example in _config.yml (notice the indentation matters):
+#
+# extlinks:
+#   attributes: {rel: nofollow, target: _blank}
+#   rel_exclude: ['host1.com', 'host2.net']
+#
+# (attributes are required - at least one of them, rel_exclude is optional)
+# Relative links will not be processed.
+# Links to hosts listed in rel_exclude will not have the 'rel' attribute set.
+# Links which have the 'rel' attribute already will keep it unchanged, like
+# this one in Markdown:
+# [Link text](http://someurl.com){:rel="dofollow"}
+#
+# Using in layouts: {{ content | extlinks }}
+#
+# Developed by Dmitry Ogarkov - http://ogarkov.com/jekyll/plugins/extlinks/
+# Based on http://dev.mensfeld.pl/2014/12/rackrails-middleware-that-will-ensure-relnofollow-for-all-your-links/
+
+require 'jekyll'
+require 'nokogiri'
+
+module Jekyll
+  module ExtLinks
+    # Access plugin config in _config.yml
+    def config
+      @context.registers[:site].config['extlinks']
+    end
+
+    # Checks if str contains any fragment of the fragments array
+    def contains_any(str, fragments)
+      return false unless Regexp.union(fragments) =~ str
+      true
+    end
+
+    def extlinks(content)
+      # Process configured link attributes and whitelisted hosts
+      if config
+        if config['attributes']
+          attributes = Array(config['attributes'])
+        end
+        if config['rel_exclude']
+          rel_exclude = Array(config['rel_exclude'])
+        end
+        if config['class_exclude']
+          class_exclude = Array(config['class_exclude'])
+        end
+      end
+      # Stop if no attributes were specified
+      return content unless attributes
+
+      doc = Nokogiri::HTML.fragment(content)
+      # Stop if we could't parse with HTML
+      return content unless doc
+
+      doc.css('a').each do |a|
+        # If this is a local link don't change it
+        next unless a.get_attribute('href') =~ /\Ahttp/i
+
+        attributes.each do |attr, value|
+          if attr.downcase == 'rel'
+            # If there's a rel already don't change it
+            next unless !a.get_attribute('rel') || a.get_attribute('rel').empty?
+            # Skip whitelisted hosts for the 'rel' attribute
+            next if rel_exclude && contains_any(a.get_attribute('href'), rel_exclude)
+          end
+          if attr.downcase == 'class'
+            # If there's a class already don't change it
+            next unless !a.get_attribute('class') || a.get_attribute('class').empty?
+            # Skip whitelisted hosts for the 'class' attribute
+            next if class_exclude && contains_any(a.get_attribute('href'), class_exclude)
+          end
+          a.set_attribute(attr, value)
+        end
+      end
+
+      doc.to_s
+    end
+
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::ExtLinks)

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: h2o-ac-jekyll-extlinks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmitry Ogarkov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: '    Adds custom attributes to external links (rel="nofollow", target="_blank",
+  etc.)
+
+  '
+email: dima@ogarkov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- License
+- README.md
+- jekyll-extlinks.gemspec
+- lib/jekyll-extlinks.rb
+homepage: https://github.com/zhonger/jekyll-extlinks/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Jekyll ExtLinks Plugin
+test_files: []