jekyll-external-links 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 874a5043ed58555922815f10b706a43d31602b33
+  data.tar.gz: 692246a4713c26ceed5ae997d1648a44f2bfe7a9
+SHA512:
+  metadata.gz: 4346f5087be47d6982afb5052eb8db9f38121dc80b9702bae39d8389c388e53d62495d61354c66a2225c37325df91747889baa0dce49732bf155326a48157f86
+  data.tar.gz: 345cde83fa3d65b18772acf03d5fc27b38dd46a1f6b4007295c7ec21f38fb191a99c5ed91c653729e14946678b71776b2bf8410bbc7503c78520ea5b8bdf5028

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ribose
+
+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,31 @@
+# Jekyll plugin that marks external links
+
+In each Jekyll document or page content, updates `<a>` elements that point
+to external sites as follows:
+
+- Adds `rel="external"` attribute
+- Adds inner HTML markup with external link icon
+
+You can specify a CSS selector for which links are to be marked,
+and a list of selectors for which links are to be ignored
+(ignored selectors take precedence).
+
+## Configuration
+
+Example configuration with defaults:
+
+```
+external_links:
+  selector: 'main a'
+  ignored_selectors:
+    - a[href*=travis]
+    - a[href*=coverity]
+    - a[href*=codecov]
+  marker_html: "<span class='ico-ext'><i class='fas fa-external-link-square-alt'></i></span>"
+```
+
+As you can see, by default the Font Awesome’s `fa-externa-link-square-alt` icon is used,
+which implies that you are using Font Awesome.
+
+You can set marker_html to empty string and style links with custom CSS rule
+(e.g., `a[rel=external] { border-bottom-style: dashed; }`), though it’s less flexible.

data/develop/release

@@ -0,0 +1,41 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Make sure the darn thing works? Meh.
+# bundle update
+
+# Build a new gem archive.
+
+rm -rf jekyll-external-links-*.gem
+gem build -q jekyll-external-links.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q 'master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls jekyll-external-links-*.gem | sed 's/^jekyll-external-links-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push jekyll-external-links-*.gem && git tag "$tag" &&
+git push origin master && git push origin "$tag"

data/jekyll-external-links.gemspec

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name          = 'jekyll-external-links'
+  s.version       = '0.1'
+  s.authors       = ['Ribose Inc.']
+  s.email         = ['open.source@ribose.com']
+
+  s.summary       = 'Jekyll plugin that marks external links in your site'
+  s.homepage      = 'https://github.com/riboseinc/jekyll-external-links/'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!) }
+
+  s.add_runtime_dependency 'jekyll', '~> 3.8'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rubocop', '~> 0.50'
+
+  s.require_paths = ["lib"]
+end

data/lib/jekyll-external-links.rb

@@ -0,0 +1,7 @@
+require 'jekyll-external-links/external_links'
+
+
+module Jekyll
+  module ExternalLinks
+  end
+end

data/lib/jekyll-external-links/external_links.rb

@@ -0,0 +1,73 @@
+require 'nokogiri'
+require 'uri'
+
+# Given hostname and content, updates any found <a> elements as follows:
+#
+# - Adds `rel` attribute
+# - Appends inner markup for external link icon
+#
+# Only processes external links where `href` starts with "http"
+# and target host does not start with given site hostname.
+def process_content(site_hostname, content, marker_html, link_selector, exclude_selectors=[])
+  content = Nokogiri::HTML(content)
+  content.css(link_selector).each do |a|
+    next if matches_one_of(a, exclude_selectors)
+    next unless a.get_attribute('href') =~ /\Ahttp/i
+    next if a.get_attribute('href') =~ /\Ahttp(s)?:\/\/#{site_hostname}\//i
+    next if a.inner_html.include? "ico-ext"
+    a.set_attribute('rel', 'external')
+    a.inner_html = "#{a.inner_html}#{marker_html}"
+  end
+  return content.to_s
+end
+
+def process_page_or_document(page_or_document)
+  site_hostname = URI(doc.site.config['url']).host
+
+  ext_link_config = doc.site.config['external_links'] || {}
+
+  # The link is marked as external by:
+  # (1) setting the rel attribute to external and
+  # (2) appending specified marker HTML.
+  # Default marker is Font Awesome icon.
+  marker_html = ext_link_config['marker_html'] || "<span class='ico-ext'><i class='fas fa-external-link-square-alt'></i></span>"
+
+  # Determines which links to mark. E.g., usually we don’t want to mark navigational links.
+  link_selector = ext_link_config['selector'] || 'main a'
+
+  # Determining which links to ignore. For example, links comprised entirely from images
+  # may look incorrectly with external marker. 
+  unmarked_link_selectors = ext_link_config['ignored_selectors'] || [
+    'a[href*=travis]',
+    'a[href*=coverity]',
+    'a[href*=codecov]',
+  ]
+
+  unless page_or_document.asset_file?
+    page_or_document.output = process_content(
+      site_hostname,
+      doc.output,
+      marker_html,
+      link_selector,
+      unmarked_link_selectors)
+  end
+end
+
+# Returns true if Nokogiri’s Node matches one of selectors,
+# otherwise return false
+def matches_one_of(node, selectors)
+  for selector in selectors
+    if node.matches? selector
+      return true
+    end
+  end
+  return false
+end
+
+Jekyll::Hooks.register :documents, :post_render do |doc|
+  mark_links_in_page_or_document(doc)
+end
+
+Jekyll::Hooks.register :pages, :post_render do |page|
+  mark_links_in_page_or_document(doc)
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-external-links
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+description: 
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- develop/release
+- jekyll-external-links.gemspec
+- lib/jekyll-external-links.rb
+- lib/jekyll-external-links/external_links.rb
+homepage: https://github.com/riboseinc/jekyll-external-links/
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin that marks external links in your site
+test_files: []